From 633ceaa9f82e0726fd15877cd9c7b6a883fccb63 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:35 +0000 Subject: [PATCH 01/45] chore: update docs/dyn/index.md --- docs/dyn/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index b29c2001f4..5610c30a25 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -1046,6 +1046,8 @@ ## policytroubleshooter * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/policytroubleshooter_v1.html) * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/policytroubleshooter_v1beta.html) +* [v3](http://googleapis.github.io/google-api-python-client/docs/dyn/policytroubleshooter_v3.html) +* [v3beta](http://googleapis.github.io/google-api-python-client/docs/dyn/policytroubleshooter_v3beta.html) ## pollen From 30f2fe3b42de74f064f3fc9cb017524223315757 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:35 +0000 Subject: [PATCH 02/45] feat(admin): update the api #### admin:directory_v1 The following keys were added: - schemas.DirectoryUsersCreateGuestRequest.properties.customer.type (Total Keys: 1) --- docs/dyn/admin_directory_v1.users.html | 1 + .../discovery_cache/documents/admin.directory_v1.json | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index e4678ac130..07a4711bd4 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -138,6 +138,7 @@

Method Details

The object takes the form of: { # Directory users guest creation request message. + "customer": "A String", # Optional. Immutable ID of the Google Workspace account. "primaryGuestEmail": "A String", # Immutable. External email of the guest user being created. } diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index b1235daad0..c2d5908389 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4689,7 +4689,7 @@ } } }, -"revision": "20251124", +"revision": "20260113", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6376,6 +6376,10 @@ false "description": "Directory users guest creation request message.", "id": "DirectoryUsersCreateGuestRequest", "properties": { +"customer": { +"description": "Optional. Immutable ID of the Google Workspace account.", +"type": "string" +}, "primaryGuestEmail": { "description": "Immutable. External email of the guest user being created.", "type": "string" From 8fc2feeb93b3a9b56eed76d08f4667e1cef3e099 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 03/45] feat(aiplatform): update the api #### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1Endpoint.properties.name.readOnly (Total Keys: 1) The following keys were added: - schemas.GoogleCloudAiplatformV1AggregationOutput (Total Keys: 5) - schemas.GoogleCloudAiplatformV1AggregationResult (Total Keys: 9) - schemas.GoogleCloudAiplatformV1CustomCodeExecutionResult (Total Keys: 5) - schemas.GoogleCloudAiplatformV1EvaluateDatasetResponse (Total Keys: 6) - schemas.GoogleCloudAiplatformV1OutputInfo (Total Keys: 4) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.name.readOnly (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 18 +-- ..._v1.projects.locations.cachedContents.html | 24 +-- ...cts.locations.deploymentResourcePools.html | 10 +- ...tform_v1.projects.locations.endpoints.html | 50 +++---- ...v1.projects.locations.evaluationItems.html | 16 +- .../dyn/aiplatform_v1.projects.locations.html | 34 ++--- ..._v1.projects.locations.indexEndpoints.html | 14 +- ....projects.locations.publishers.models.html | 20 +-- ...1.projects.locations.reasoningEngines.html | 24 +-- ...s.locations.reasoningEngines.memories.html | 2 +- ...ions.reasoningEngines.sessions.events.html | 2 +- ...s.locations.reasoningEngines.sessions.html | 2 +- ...form_v1.projects.locations.tuningJobs.html | 30 ++-- docs/dyn/aiplatform_v1.publishers.models.html | 22 +-- docs/dyn/aiplatform_v1.reasoningEngines.html | 24 +-- docs/dyn/aiplatform_v1.v1.html | 22 +-- docs/dyn/aiplatform_v1beta1.endpoints.html | 18 +-- ...ta1.projects.locations.cachedContents.html | 24 +-- ...m_v1beta1.projects.locations.datasets.html | 8 +- ...cts.locations.deploymentResourcePools.html | 10 +- ..._v1beta1.projects.locations.endpoints.html | 50 +++---- ...a1.projects.locations.evaluationItems.html | 48 +++--- ...ta1.projects.locations.evaluationRuns.html | 8 +- ...eta1.projects.locations.exampleStores.html | 18 +-- ...v1beta1.projects.locations.extensions.html | 4 +- ...aiplatform_v1beta1.projects.locations.html | 36 ++--- ...ta1.projects.locations.indexEndpoints.html | 14 +- ....projects.locations.publishers.models.html | 20 +-- ...1.projects.locations.reasoningEngines.html | 24 +-- ...s.locations.reasoningEngines.memories.html | 2 +- ...ions.reasoningEngines.sessions.events.html | 2 +- ...s.locations.reasoningEngines.sessions.html | 2 +- ...v1beta1.projects.locations.tuningJobs.html | 74 +++++----- .../aiplatform_v1beta1.publishers.models.html | 26 ++-- .../aiplatform_v1beta1.reasoningEngines.html | 24 +-- ...orm_v1beta1.reasoningEngines.memories.html | 2 +- ...eta1.reasoningEngines.sessions.events.html | 2 +- ...orm_v1beta1.reasoningEngines.sessions.html | 2 +- docs/dyn/aiplatform_v1beta1.v1beta1.html | 22 +-- .../documents/aiplatform.v1.json | 138 ++++++++++++++++-- .../documents/aiplatform.v1beta1.json | 27 ++-- 41 files changed, 519 insertions(+), 400 deletions(-) diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index c99c374c29..08f78c66f5 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -186,7 +186,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -300,7 +300,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -490,7 +490,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -849,7 +849,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1049,7 +1049,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1378,7 +1378,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1717,7 +1717,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1917,7 +1917,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2246,7 +2246,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 002ab764ec..decd906b17 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -173,7 +173,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -255,7 +255,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -575,7 +575,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -657,7 +657,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1002,7 +1002,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1084,7 +1084,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1415,7 +1415,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1497,7 +1497,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1836,7 +1836,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1918,7 +1918,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2239,7 +2239,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2321,7 +2321,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html index badd9fe8ed..d12aa26a5c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1.projects.locations.deploymentResourcePools.html @@ -127,7 +127,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -245,7 +245,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -302,7 +302,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -367,7 +367,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -465,7 +465,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 76475efd81..d7ca77761e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -254,7 +254,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -368,7 +368,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -558,7 +558,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -829,7 +829,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -1017,7 +1017,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -1136,7 +1136,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -1813,7 +1813,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2013,7 +2013,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2342,7 +2342,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2556,7 +2556,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -2744,7 +2744,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -2819,7 +2819,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -3007,7 +3007,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -3079,7 +3079,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -3284,7 +3284,7 @@

Method Details

Updates an Endpoint.
 
 Args:
-  name: string, Output only. The resource name of the Endpoint. (required)
+  name: string, Identifier. The resource name of the Endpoint. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3306,7 +3306,7 @@ 

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -3494,7 +3494,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -3555,7 +3555,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -3743,7 +3743,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -4163,7 +4163,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4363,7 +4363,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4692,7 +4692,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4964,7 +4964,7 @@

Method Details

Updates an Endpoint with a long running operation.
 
 Args:
-  name: string, Output only. The resource name of the Endpoint. (required)
+  name: string, Identifier. The resource name of the Endpoint. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -4987,7 +4987,7 @@ 

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -5175,7 +5175,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 51a33021a4..23f2b50d48 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -197,7 +197,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -340,7 +340,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -483,7 +483,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -626,7 +626,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -811,7 +811,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -954,7 +954,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1110,7 +1110,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1253,7 +1253,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 5629bc69cb..9d905c597f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -374,7 +374,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -492,7 +492,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -601,7 +601,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -672,7 +672,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -1624,7 +1624,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1918,7 +1918,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1997,7 +1997,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2291,7 +2291,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2373,7 +2373,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2453,7 +2453,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2533,7 +2533,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2945,7 +2945,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3066,7 +3066,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3700,7 +3700,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3992,7 +3992,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4238,7 +4238,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4341,7 +4341,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index 22b58c0d01..90cebe43ef 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -142,7 +142,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -328,7 +328,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -579,7 +579,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -715,7 +715,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -854,7 +854,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -971,7 +971,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -1095,7 +1095,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index ff08d4ca18..9a720341bd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -188,7 +188,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -302,7 +302,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -492,7 +492,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -808,7 +808,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -991,7 +991,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1191,7 +1191,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1520,7 +1520,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2087,7 +2087,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2287,7 +2287,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2616,7 +2616,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index ae88163011..8681c3d1b9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -211,7 +211,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -329,7 +329,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -348,7 +348,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -552,7 +552,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -670,7 +670,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -689,7 +689,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -789,7 +789,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -907,7 +907,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -926,7 +926,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -1031,7 +1031,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1149,7 +1149,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -1168,7 +1168,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 18c62f87ae..4cb205f5e8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -304,7 +304,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html index 08242e81ea..7d6afc68c7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html @@ -187,7 +187,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html index 0fcbff2142..8733559e94 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html @@ -195,7 +195,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 2cb896373c..d2b4a7991d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -311,7 +311,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -388,7 +388,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -511,7 +511,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -760,7 +760,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -837,7 +837,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -960,7 +960,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1216,7 +1216,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1293,7 +1293,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1416,7 +1416,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1678,7 +1678,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1755,7 +1755,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1878,7 +1878,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2155,7 +2155,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2232,7 +2232,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2355,7 +2355,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 8153e8ad82..fd8ab17101 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -179,7 +179,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -293,7 +293,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -483,7 +483,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -842,7 +842,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1042,7 +1042,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1371,7 +1371,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1741,7 +1741,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -1921,7 +1921,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. }, ], @@ -2285,7 +2285,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2485,7 +2485,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2814,7 +2814,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 585ca09376..b4d12912a2 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -210,7 +210,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -328,7 +328,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -347,7 +347,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -552,7 +552,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -670,7 +670,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -689,7 +689,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -789,7 +789,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -907,7 +907,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -926,7 +926,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -1031,7 +1031,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1149,7 +1149,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -1168,7 +1168,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index 2a058d8115..1e9919cf4d 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -822,7 +822,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1116,7 +1116,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1195,7 +1195,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1489,7 +1489,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1571,7 +1571,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1651,7 +1651,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1731,7 +1731,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2143,7 +2143,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2264,7 +2264,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2897,7 +2897,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3189,7 +3189,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index bee3c747c5..1d70c6b90c 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -188,7 +188,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -304,7 +304,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -499,7 +499,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -867,7 +867,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1072,7 +1072,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1410,7 +1410,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1754,7 +1754,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1959,7 +1959,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2297,7 +2297,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 5b43d1daa3..6b5a47e47c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -175,7 +175,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -259,7 +259,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -588,7 +588,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -672,7 +672,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1026,7 +1026,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1110,7 +1110,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1450,7 +1450,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1534,7 +1534,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1882,7 +1882,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1966,7 +1966,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2296,7 +2296,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2380,7 +2380,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 2a2182467a..cfa86213f2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -230,7 +230,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -432,7 +432,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -799,7 +799,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1001,7 +1001,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html index c6799f171c..6e1f17f43a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html @@ -127,7 +127,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -258,7 +258,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -328,7 +328,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -406,7 +406,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Required. The underlying DedicatedResources that the DeploymentResourcePool uses. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -517,7 +517,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index ae4543af1a..fa24ca0c6c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -265,7 +265,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -381,7 +381,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -576,7 +576,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -854,7 +854,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -1073,7 +1073,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -1195,7 +1195,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -2033,7 +2033,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2238,7 +2238,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2576,7 +2576,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2793,7 +2793,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -3012,7 +3012,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -3124,7 +3124,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -3343,7 +3343,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -3418,7 +3418,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -3654,7 +3654,7 @@

Method Details

Updates an Endpoint.
 
 Args:
-  name: string, Output only. The resource name of the Endpoint. (required)
+  name: string, Identifier. The resource name of the Endpoint. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3676,7 +3676,7 @@ 

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -3895,7 +3895,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -3959,7 +3959,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -4178,7 +4178,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` @@ -4661,7 +4661,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4866,7 +4866,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -5204,7 +5204,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -5501,7 +5501,7 @@

Method Details

Updates an Endpoint with a long running operation.
 
 Args:
-  name: string, Output only. The resource name of the Endpoint. (required)
+  name: string, Identifier. The resource name of the Endpoint. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -5524,7 +5524,7 @@ 

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -5743,7 +5743,7 @@

Method Details

"a_key": "A String", }, "modelDeploymentMonitoringJob": "A String", # Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` - "name": "A String", # Output only. The resource name of the Endpoint. + "name": "A String", # Identifier. The resource name of the Endpoint. "network": "A String", # Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. "predictRequestResponseLoggingConfig": { # Configuration for logging request-response to a BigQuery table. # Configures the request-response logging for online prediction. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index ee524e3e43..6744a1a680 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -193,7 +193,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -276,7 +276,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -358,7 +358,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -492,7 +492,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -575,7 +575,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -657,7 +657,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -791,7 +791,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -874,7 +874,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -956,7 +956,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1090,7 +1090,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1173,7 +1173,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1255,7 +1255,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1431,7 +1431,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1514,7 +1514,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1596,7 +1596,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1730,7 +1730,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1813,7 +1813,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1895,7 +1895,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2042,7 +2042,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2125,7 +2125,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2207,7 +2207,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2341,7 +2341,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2424,7 +2424,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2506,7 +2506,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 1cdc83efd5..11c1dcff83 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -1349,7 +1349,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2923,7 +2923,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4539,7 +4539,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -6126,7 +6126,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 93521e458e..f36008b7d9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -305,7 +305,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -383,7 +383,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -665,7 +665,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -775,7 +775,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -853,7 +853,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -962,7 +962,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1040,7 +1040,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1147,7 +1147,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1225,7 +1225,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index f547ca8ebf..9dd8caead6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1208,7 +1208,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1297,7 +1297,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 7044c8371d..0f0154f9e8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -427,7 +427,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -554,7 +554,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -665,7 +665,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -740,7 +740,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -988,7 +988,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -1805,7 +1805,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2108,7 +2108,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2189,7 +2189,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2492,7 +2492,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2576,7 +2576,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2658,7 +2658,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2740,7 +2740,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3160,7 +3160,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3283,7 +3283,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3919,7 +3919,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4220,7 +4220,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4471,7 +4471,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4576,7 +4576,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index 6cdd955f96..90a77ecf2b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -142,7 +142,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -342,7 +342,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -606,7 +606,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -756,7 +756,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -909,7 +909,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -1039,7 +1039,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -1177,7 +1177,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 45b5813cb0..288372d2a7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -202,7 +202,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -318,7 +318,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -513,7 +513,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -838,7 +838,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1095,7 +1095,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1300,7 +1300,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1638,7 +1638,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2297,7 +2297,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2502,7 +2502,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2840,7 +2840,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index ad2e09f409..489ffa4c8c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -223,7 +223,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -345,7 +345,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -364,7 +364,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -570,7 +570,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -692,7 +692,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -711,7 +711,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -813,7 +813,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -935,7 +935,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -954,7 +954,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -1061,7 +1061,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1183,7 +1183,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -1202,7 +1202,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index c9c8f88eed..000990b4da 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -306,7 +306,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. 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 99e9e7a4fb..ffcf021ef1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -189,7 +189,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 38a27796ba..f4cf1e5743 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -197,7 +197,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 32a529bc5c..9701eaf82a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -185,8 +185,8 @@

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. }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. "aggregationResults": [ # One AggregationResult per metric. { # The aggregation result for a single metric. "aggregationMetric": "A String", # Aggregation metric. @@ -237,7 +237,7 @@

Method Details

}, }, }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, @@ -823,7 +823,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -995,7 +995,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1074,7 +1074,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1199,7 +1199,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1330,8 +1330,8 @@

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. }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. "aggregationResults": [ # One AggregationResult per metric. { # The aggregation result for a single metric. "aggregationMetric": "A String", # Aggregation metric. @@ -1382,7 +1382,7 @@

Method Details

}, }, }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, @@ -1968,7 +1968,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2140,7 +2140,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2219,7 +2219,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2344,7 +2344,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2482,8 +2482,8 @@

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. }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. "aggregationResults": [ # One AggregationResult per metric. { # The aggregation result for a single metric. "aggregationMetric": "A String", # Aggregation metric. @@ -2534,7 +2534,7 @@

Method Details

}, }, }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, @@ -3120,7 +3120,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3292,7 +3292,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3371,7 +3371,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3496,7 +3496,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3640,8 +3640,8 @@

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. }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. "aggregationResults": [ # One AggregationResult per metric. { # The aggregation result for a single metric. "aggregationMetric": "A String", # Aggregation metric. @@ -3692,7 +3692,7 @@

Method Details

}, }, }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, @@ -4278,7 +4278,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4450,7 +4450,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4529,7 +4529,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4654,7 +4654,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4824,7 +4824,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4911,7 +4911,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -4988,8 +4988,8 @@

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. }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "evaluateDatasetResponse": { # The results from an evaluation run performed by the EvaluationService. # Output only. Results for EvaluationService. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService. "aggregationResults": [ # One AggregationResult per metric. { # The aggregation result for a single metric. "aggregationMetric": "A String", # Aggregation metric. @@ -5040,7 +5040,7 @@

Method Details

}, }, }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "outputInfo": { # Describes the info for output of EvaluationService. # Output only. Output info for EvaluationService. "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, @@ -5626,7 +5626,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -5798,7 +5798,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -5877,7 +5877,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -6002,7 +6002,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index efbaad868a..6ddf042f16 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -187,7 +187,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -303,7 +303,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -498,7 +498,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -866,7 +866,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1071,7 +1071,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1409,7 +1409,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1792,7 +1792,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -1985,7 +1985,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -2408,7 +2408,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -2601,7 +2601,7 @@

Method Details

"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` + "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting` "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info "a_key": "A String", }, @@ -2996,7 +2996,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3201,7 +3201,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3539,7 +3539,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 35c35afe09..995fa2b5c4 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -222,7 +222,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -344,7 +344,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -363,7 +363,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -570,7 +570,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -692,7 +692,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -711,7 +711,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -813,7 +813,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -935,7 +935,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -954,7 +954,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, @@ -1061,7 +1061,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1183,7 +1183,7 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. @@ -1202,7 +1202,7 @@

Method Details

"entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`. "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`. "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". - "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 9f43883a94..c29d726125 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -306,7 +306,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index ce19cea97a..7180930d58 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -189,7 +189,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index d9e1d5e6bb..3e04f3303d 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -197,7 +197,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 1d7a1db531..571c5f260c 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -836,7 +836,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1139,7 +1139,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1220,7 +1220,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1523,7 +1523,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1607,7 +1607,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1689,7 +1689,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1771,7 +1771,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2191,7 +2191,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2314,7 +2314,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2949,7 +2949,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -3250,7 +3250,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index f99aa7fc5f..fe684cd24a 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -10004,7 +10004,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Endpoint.", +"description": "Identifier. The resource name of the Endpoint.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, @@ -10240,7 +10240,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Endpoint.", +"description": "Identifier. The resource name of the Endpoint.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, @@ -30639,7 +30639,7 @@ } } }, -"revision": "20260106", +"revision": "20260110", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -31183,6 +31183,85 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AggregationOutput": { +"description": "The aggregation result for the entire dataset and all metrics.", +"id": "GoogleCloudAiplatformV1AggregationOutput", +"properties": { +"aggregationResults": { +"description": "One AggregationResult per metric.", +"items": { +"$ref": "GoogleCloudAiplatformV1AggregationResult" +}, +"type": "array" +}, +"dataset": { +"$ref": "GoogleCloudAiplatformV1EvaluationDataset", +"description": "The dataset used for evaluation & aggregation." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AggregationResult": { +"description": "The aggregation result for a single metric.", +"id": "GoogleCloudAiplatformV1AggregationResult", +"properties": { +"aggregationMetric": { +"description": "Aggregation metric.", +"enum": [ +"AGGREGATION_METRIC_UNSPECIFIED", +"AVERAGE", +"MODE", +"STANDARD_DEVIATION", +"VARIANCE", +"MINIMUM", +"MAXIMUM", +"MEDIAN", +"PERCENTILE_P90", +"PERCENTILE_P95", +"PERCENTILE_P99" +], +"enumDescriptions": [ +"Unspecified aggregation metric.", +"Average aggregation metric. Not supported for Pairwise metric.", +"Mode aggregation metric.", +"Standard deviation aggregation metric. Not supported for pairwise metric.", +"Variance aggregation metric. Not supported for pairwise metric.", +"Minimum aggregation metric. Not supported for pairwise metric.", +"Maximum aggregation metric. Not supported for pairwise metric.", +"Median aggregation metric. Not supported for pairwise metric.", +"90th percentile aggregation metric. Not supported for pairwise metric.", +"95th percentile aggregation metric. Not supported for pairwise metric.", +"99th percentile aggregation metric. Not supported for pairwise metric." +], +"type": "string" +}, +"bleuMetricValue": { +"$ref": "GoogleCloudAiplatformV1BleuMetricValue", +"description": "Results for bleu metric." +}, +"customCodeExecutionResult": { +"$ref": "GoogleCloudAiplatformV1CustomCodeExecutionResult", +"description": "Result for code execution metric." +}, +"exactMatchMetricValue": { +"$ref": "GoogleCloudAiplatformV1ExactMatchMetricValue", +"description": "Results for exact match metric." +}, +"pairwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricResult", +"description": "Result for pairwise metric." +}, +"pointwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricResult", +"description": "Result for pointwise metric." +}, +"rougeMetricValue": { +"$ref": "GoogleCloudAiplatformV1RougeMetricValue", +"description": "Results for rouge metric." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Annotation": { "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", "id": "GoogleCloudAiplatformV1Annotation", @@ -31699,7 +31778,7 @@ "id": "GoogleCloudAiplatformV1AutoscalingMetricSpec", "properties": { "metricName": { -"description": "Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages`", +"description": "Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting`", "type": "string" }, "target": { @@ -34072,6 +34151,19 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CustomCodeExecutionResult": { +"description": "Result for custom code execution metric.", +"id": "GoogleCloudAiplatformV1CustomCodeExecutionResult", +"properties": { +"score": { +"description": "Output only. Custom code execution score.", +"format": "float", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CustomCodeExecutionSpec": { "description": "Specificies a metric that is populated by evaluating user-defined Python code.", "id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec", @@ -35812,8 +35904,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Endpoint.", -"readOnly": true, +"description": "Identifier. The resource name of the Endpoint.", "type": "string" }, "network": { @@ -36064,6 +36155,23 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluateDatasetResponse": { +"description": "The results from an evaluation run performed by the EvaluationService.", +"id": "GoogleCloudAiplatformV1EvaluateDatasetResponse", +"properties": { +"aggregationOutput": { +"$ref": "GoogleCloudAiplatformV1AggregationOutput", +"description": "Output only. Aggregation statistics derived from results of EvaluationService.", +"readOnly": true +}, +"outputInfo": { +"$ref": "GoogleCloudAiplatformV1OutputInfo", +"description": "Output only. Output info for EvaluationService.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluateInstancesRequest": { "description": "Request message for EvaluationService.EvaluateInstances.", "id": "GoogleCloudAiplatformV1EvaluateInstancesRequest", @@ -47642,6 +47750,18 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1OutputInfo": { +"description": "Describes the info for output of EvaluationService.", +"id": "GoogleCloudAiplatformV1OutputInfo", +"properties": { +"gcsOutputDirectory": { +"description": "Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PSCAutomationConfig": { "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", "id": "GoogleCloudAiplatformV1PSCAutomationConfig", @@ -47997,7 +48117,7 @@ false "description": "per part media resolution. Media resolution for the input media." }, "text": { -"description": "Optional. The text content of the part.", +"description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", "type": "string" }, "thought": { @@ -51457,7 +51577,7 @@ false "type": "string" }, "pythonVersion": { -"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", +"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -51545,7 +51665,7 @@ false "type": "string" }, "version": { -"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.", +"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 7c42d24f6b..8ae0900abc 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -12473,7 +12473,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Endpoint.", +"description": "Identifier. The resource name of the Endpoint.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, @@ -12768,7 +12768,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Endpoint.", +"description": "Identifier. The resource name of the Endpoint.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, @@ -37771,7 +37771,7 @@ } } }, -"revision": "20260106", +"revision": "20260110", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -39041,7 +39041,7 @@ "id": "GoogleCloudAiplatformV1beta1AutoscalingMetricSpec", "properties": { "metricName": { -"description": "Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages`", +"description": "Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting`", "type": "string" }, "monitoredResourceLabels": { @@ -43578,8 +43578,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Endpoint.", -"readOnly": true, +"description": "Identifier. The resource name of the Endpoint.", "type": "string" }, "network": { @@ -43831,17 +43830,17 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse": { -"description": "Response in LRO for EvaluationService.EvaluateDataset.", +"description": "The results from an evaluation run performed by the EvaluationService.", "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse", "properties": { "aggregationOutput": { "$ref": "GoogleCloudAiplatformV1beta1AggregationOutput", -"description": "Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset.", +"description": "Output only. Aggregation statistics derived from results of EvaluationService.", "readOnly": true }, "outputInfo": { "$ref": "GoogleCloudAiplatformV1beta1OutputInfo", -"description": "Output only. Output info for EvaluationService.EvaluateDataset.", +"description": "Output only. Output info for EvaluationService.", "readOnly": true } }, @@ -43863,7 +43862,7 @@ }, "evaluateDatasetResponse": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse", -"description": "Output only. Results for EvaluationService.EvaluateDataset.", +"description": "Output only. Results for EvaluationService.", "readOnly": true }, "operationName": { @@ -57583,7 +57582,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1OutputInfo": { -"description": "Describes the info for output of EvaluationService.EvaluateDataset.", +"description": "Describes the info for output of EvaluationService.", "id": "GoogleCloudAiplatformV1beta1OutputInfo", "properties": { "gcsOutputDirectory": { @@ -57949,7 +57948,7 @@ false "description": "per part media resolution. Media resolution for the input media." }, "text": { -"description": "Optional. The text content of the part.", +"description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", "type": "string" }, "thought": { @@ -62012,7 +62011,7 @@ false "type": "string" }, "pythonVersion": { -"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.", +"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.", "type": "string" }, "requirementsGcsUri": { @@ -62100,7 +62099,7 @@ false "type": "string" }, "version": { -"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.", +"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", "type": "string" } }, From 6a2be00c6fe1b504af247fafb6c5b044f93d9e09 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 04/45] feat(alloydb): update the api #### alloydb:v1 The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata (Total Keys: 12) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.bigqueryResourceMetadata.$ref (Total Keys: 1) The following keys were added: - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.baselineSlots (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.maxReservationSlots (Total Keys: 2) #### alloydb:v1alpha The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata (Total Keys: 12) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.bigqueryResourceMetadata.$ref (Total Keys: 1) The following keys were added: - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.baselineSlots (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.maxReservationSlots (Total Keys: 2) #### alloydb:v1beta The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata (Total Keys: 12) - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.bigqueryResourceMetadata.$ref (Total Keys: 1) The following keys were added: - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.baselineSlots (Total Keys: 2) - schemas.StorageDatabasecenterPartnerapiV1mainMachineConfiguration.properties.maxReservationSlots (Total Keys: 2) --- .../discovery_cache/documents/alloydb.v1.json | 87 +++++++------------ .../documents/alloydb.v1alpha.json | 87 +++++++------------ .../documents/alloydb.v1beta.json | 87 +++++++------------ 3 files changed, 90 insertions(+), 171 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index ab11169617..596f47f1bb 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20251211", +"revision": "20260108", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3340,7 +3340,9 @@ false "FAILED", "BOOTSTRAPPING", "PROMOTING", -"SWITCHOVER" +"SWITCHOVER", +"STOPPING", +"STARTING" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3352,7 +3354,9 @@ false "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", "The instance is being promoted.", -"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." +"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state.", +"The instance is being stopped.", +"The instance is being started." ], "readOnly": true, "type": "string" @@ -4587,47 +4591,6 @@ false }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata": { -"description": "BigQueryResourceMetadata contains information about the BigQuery resource. Next ID: 9", -"id": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"properties": { -"createTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", -"format": "google-datetime", -"type": "string" -}, -"fullResourceName": { -"description": "Required. Full resource name of this instance.", -"type": "string" -}, -"location": { -"description": "Required. location of the resource", -"type": "string" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." -}, -"resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", -"type": "string" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." -}, -"updateTime": { -"description": "The time at which the resource was updated and recorded at partner service.", -"format": "google-datetime", -"type": "string" -}, -"userLabelSet": { -"$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainCompliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", @@ -4713,10 +4676,6 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "description": "BackupDR metadata is used to ingest metadata from BackupDR." }, -"bigqueryResourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"description": "For BigQuery resource metadata." -}, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." @@ -4740,8 +4699,7 @@ false "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", "BACKUPDR_METADATA", -"DATABASE_RESOURCE_SIGNAL_DATA", -"BIGQUERY_RESOURCE_METADATA" +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4751,8 +4709,7 @@ false "Database resource recommendation signal data", "Database config based signal data", "Database resource metadata from BackupDR", -"Database resource signal data", -"BigQuery resource metadata" +"Database resource signal data" ], "type": "string" }, @@ -4999,7 +4956,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -5106,6 +5064,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5213,7 +5172,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" }, @@ -5266,7 +5226,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigquery.googleapis.com/Dataset, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5658,7 +5618,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -5765,6 +5726,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5872,7 +5834,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" } @@ -6031,12 +5994,22 @@ false "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { +"baselineSlots": { +"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "cpuCount": { "deprecated": true, "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, +"maxReservationSlots": { +"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "memorySizeInBytes": { "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 64bf978ac0..f75d714cd8 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20251211", +"revision": "20260108", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3522,7 +3522,9 @@ false "FAILED", "BOOTSTRAPPING", "PROMOTING", -"SWITCHOVER" +"SWITCHOVER", +"STOPPING", +"STARTING" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3534,7 +3536,9 @@ false "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", "The instance is being promoted.", -"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." +"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state.", +"The instance is being stopped.", +"The instance is being started." ], "readOnly": true, "type": "string" @@ -4847,47 +4851,6 @@ false }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata": { -"description": "BigQueryResourceMetadata contains information about the BigQuery resource. Next ID: 9", -"id": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"properties": { -"createTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", -"format": "google-datetime", -"type": "string" -}, -"fullResourceName": { -"description": "Required. Full resource name of this instance.", -"type": "string" -}, -"location": { -"description": "Required. location of the resource", -"type": "string" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." -}, -"resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", -"type": "string" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." -}, -"updateTime": { -"description": "The time at which the resource was updated and recorded at partner service.", -"format": "google-datetime", -"type": "string" -}, -"userLabelSet": { -"$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainCompliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", @@ -4973,10 +4936,6 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "description": "BackupDR metadata is used to ingest metadata from BackupDR." }, -"bigqueryResourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"description": "For BigQuery resource metadata." -}, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." @@ -5000,8 +4959,7 @@ false "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", "BACKUPDR_METADATA", -"DATABASE_RESOURCE_SIGNAL_DATA", -"BIGQUERY_RESOURCE_METADATA" +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -5011,8 +4969,7 @@ false "Database resource recommendation signal data", "Database config based signal data", "Database resource metadata from BackupDR", -"Database resource signal data", -"BigQuery resource metadata" +"Database resource signal data" ], "type": "string" }, @@ -5259,7 +5216,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -5366,6 +5324,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5473,7 +5432,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" }, @@ -5526,7 +5486,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigquery.googleapis.com/Dataset, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5918,7 +5878,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -6025,6 +5986,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -6132,7 +6094,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" } @@ -6291,12 +6254,22 @@ false "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { +"baselineSlots": { +"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "cpuCount": { "deprecated": true, "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, +"maxReservationSlots": { +"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "memorySizeInBytes": { "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 08353e3aa9..f49e2441c5 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1876,7 +1876,7 @@ } } }, -"revision": "20251211", +"revision": "20260108", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3498,7 +3498,9 @@ false "FAILED", "BOOTSTRAPPING", "PROMOTING", -"SWITCHOVER" +"SWITCHOVER", +"STOPPING", +"STARTING" ], "enumDescriptions": [ "The state of the instance is unknown.", @@ -3510,7 +3512,9 @@ false "The creation of the instance failed or a fatal error occurred during an operation on the instance. Note: Instances in this state would tried to be auto-repaired. And Customers should be able to restart, update or delete these instances.", "The instance has been configured to sync data from some other source.", "The instance is being promoted.", -"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state." +"The instance has entered switchover state. All updates on instance are restricted while the instance is in this state.", +"The instance is being stopped.", +"The instance is being started." ], "readOnly": true, "type": "string" @@ -4823,47 +4827,6 @@ false }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata": { -"description": "BigQueryResourceMetadata contains information about the BigQuery resource. Next ID: 9", -"id": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"properties": { -"createTime": { -"description": "The creation time of the resource, i.e. the time when resource is created and recorded in partner service.", -"format": "google-datetime", -"type": "string" -}, -"fullResourceName": { -"description": "Required. Full resource name of this instance.", -"type": "string" -}, -"location": { -"description": "Required. location of the resource", -"type": "string" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct", -"description": "The product this resource represents." -}, -"resourceContainer": { -"description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"/\", such as \"projects/123\". For GCP provided resources, number should be project number.", -"type": "string" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", -"description": "Required. Database resource id." -}, -"updateTime": { -"description": "The time at which the resource was updated and recorded at partner service.", -"format": "google-datetime", -"type": "string" -}, -"userLabelSet": { -"$ref": "StorageDatabasecenterPartnerapiV1mainUserLabels", -"description": "User-provided labels associated with the resource" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainCompliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "StorageDatabasecenterPartnerapiV1mainCompliance", @@ -4949,10 +4912,6 @@ false "$ref": "StorageDatabasecenterPartnerapiV1mainBackupDRMetadata", "description": "BackupDR metadata is used to ingest metadata from BackupDR." }, -"bigqueryResourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBigQueryResourceMetadata", -"description": "For BigQuery resource metadata." -}, "configBasedSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData", "description": "Config based signal data is used to ingest signals that are generated based on the configuration of the database resource." @@ -4976,8 +4935,7 @@ false "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", "BACKUPDR_METADATA", -"DATABASE_RESOURCE_SIGNAL_DATA", -"BIGQUERY_RESOURCE_METADATA" +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4987,8 +4945,7 @@ false "Database resource recommendation signal data", "Database config based signal data", "Database resource metadata from BackupDR", -"Database resource signal data", -"BigQuery resource metadata" +"Database resource signal data" ], "type": "string" }, @@ -5235,7 +5192,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -5342,6 +5300,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5449,7 +5408,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" }, @@ -5502,7 +5462,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigquery.googleapis.com/Dataset, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5894,7 +5854,8 @@ false "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", -"SIGNAL_TYPE_EXTENDED_SUPPORT" +"SIGNAL_TYPE_EXTENDED_SUPPORT", +"SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE" ], "enumDeprecated": [ false, @@ -6001,6 +5962,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -6108,7 +6070,8 @@ false "Outdated client.", "Databoost is disabled.", "Recommended maintenance policy.", -"Resource version is in extended support." +"Resource version is in extended support.", +"Change in performance KPIs." ], "type": "string" } @@ -6267,12 +6230,22 @@ false "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", "properties": { +"baselineSlots": { +"description": "Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "cpuCount": { "deprecated": true, "description": "The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.", "format": "int32", "type": "integer" }, +"maxReservationSlots": { +"description": "Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.", +"format": "int64", +"type": "string" +}, "memorySizeInBytes": { "description": "Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.", "format": "int64", From 858196eaf6f5ce212948a8c1c18edacedba33224 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 05/45] feat(analyticshub): update the api #### analyticshub:v1 The following keys were added: - schemas.AIInference (Total Keys: 5) - schemas.MessageTransform.properties.aiInference.$ref (Total Keys: 1) - schemas.UnstructuredInference (Total Keys: 4) --- ...ects.locations.dataExchanges.listings.html | 9 +++++ .../documents/analyticshub.v1.json | 40 ++++++++++++++++++- 2 files changed, 48 insertions(+), 1 deletion(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 362d575c89..12b9ba9965 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -960,6 +960,15 @@

Method Details

"messageRetentionDuration": "A String", # Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. "messageTransforms": [ # Optional. Transforms to be applied to messages before they are delivered to subscribers. Transforms are applied in the order specified. { # All supported message transforms types. + "aiInference": { # Configuration for making inference requests against Vertex AI models. # Optional. AI Inference. + "endpoint": "A String", # Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint. + "serviceAccountEmail": "A String", # Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. + "unstructuredInference": { # Configuration for making inferences using arbitrary JSON payloads. # Optional. Requests and responses can be any arbitrary JSON object. + "parameters": { # Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request. + "a_key": "", # Properties of the object. + }, + }, + }, "disabled": True or False, # Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`. "enabled": True or False, # Optional. This field is deprecated, use the `disabled` field to disable transforms. "javascriptUdf": { # User-defined JavaScript function that can transform or filter a Pub/Sub message. # Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are specified on a resource, each must have a unique `function_name`. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 49a8e33c66..632e4dd285 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,9 +1247,28 @@ } } }, -"revision": "20251208", +"revision": "20260111", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { +"AIInference": { +"description": "Configuration for making inference requests against Vertex AI models.", +"id": "AIInference", +"properties": { +"endpoint": { +"description": "Required. An endpoint to a Vertex AI model of the form `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. Vertex AI API requests will be sent to this endpoint.", +"type": "string" +}, +"serviceAccountEmail": { +"description": "Optional. The service account to use to make prediction requests against endpoints. The resource creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent]({$universe.dns_names.final_documentation_domain}/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", +"type": "string" +}, +"unstructuredInference": { +"$ref": "UnstructuredInference", +"description": "Optional. Requests and responses can be any arbitrary JSON object." +} +}, +"type": "object" +}, "ApproveQueryTemplateRequest": { "description": "Message for approving a QueryTemplate.", "id": "ApproveQueryTemplateRequest", @@ -2166,6 +2185,10 @@ "description": "All supported message transforms types.", "id": "MessageTransform", "properties": { +"aiInference": { +"$ref": "AIInference", +"description": "Optional. AI Inference." +}, "disabled": { "description": "Optional. If true, the transform is disabled and will not be applied to messages. Defaults to `false`.", "type": "boolean" @@ -2917,6 +2940,21 @@ "id": "TextConfig", "properties": {}, "type": "object" +}, +"UnstructuredInference": { +"description": "Configuration for making inferences using arbitrary JSON payloads.", +"id": "UnstructuredInference", +"properties": { +"parameters": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A parameters object to be included in each inference request. The parameters object is combined with the data field of the Pub/Sub message to form the inference request.", +"type": "object" +} +}, +"type": "object" } }, "servicePath": "", From 9f1a1f22b687009ccf213840c0129cc9ef6ca07a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 06/45] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were added: - schemas.DeviceRadioState.properties.userInitiatedAddEsimSettings.type (Total Keys: 1) --- ...ndroidmanagement_v1.enterprises.policies.html | 6 ++++++ .../documents/androidmanagement.v1.json | 16 +++++++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index b560dd9351..fc38d04c06 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -368,6 +368,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. @@ -890,6 +891,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. @@ -1498,6 +1500,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. @@ -2011,6 +2014,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. @@ -2522,6 +2526,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. @@ -3049,6 +3054,7 @@

Method Details

"cellularTwoGState": "A String", # Controls whether cellular 2G setting can be toggled by the user or not. "minimumWifiSecurityLevel": "A String", # The minimum required security level of Wi-Fi networks that the device can connect to. "ultraWidebandState": "A String", # Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + "userInitiatedAddEsimSettings": "A String", # Optional. Controls whether the user is allowed to add eSIM profiles. "wifiState": "A String", # Controls current state of Wi-Fi and if user can change its state. }, "displaySettings": { # Controls for the display settings. # Optional. Controls for the display settings. diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index aadd22f99a..db695a8c6e 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260105", +"revision": "20260113", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -3644,6 +3644,20 @@ false ], "type": "string" }, +"userInitiatedAddEsimSettings": { +"description": "Optional. Controls whether the user is allowed to add eSIM profiles.", +"enum": [ +"USER_INITIATED_ADD_ESIM_SETTINGS_UNSPECIFIED", +"USER_INITIATED_ADD_ESIM_ALLOWED", +"USER_INITIATED_ADD_ESIM_DISALLOWED" +], +"enumDescriptions": [ +"Unspecified. Defaults to USER_INITIATED_ADD_ESIM_ALLOWED.", +"The user is allowed to add eSIM profiles.", +"Supported only on company-owned devices. A NonComplianceDetail with MANAGEMENT_MODE is reported for personally-owned devices." +], +"type": "string" +}, "wifiState": { "description": "Controls current state of Wi-Fi and if user can change its state.", "enum": [ From 3ada821757c008224e951934d731cb7ab4a9ac53 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 07/45] feat(appengine): update the api #### appengine:v1 The following keys were deleted: - resources.apps.resources.services.resources.versions.methods.exportAppImage (Total Keys: 17) - resources.projects.resources.locations.resources.applications.resources.services.resources.versions.methods.exportAppImage (Total Keys: 23) - schemas.ExportAppImageRequest (Total Keys: 4) The following keys were added: - resources.projects.resources.locations.resources.applications.resources.services.resources.versions.resources.instances.methods.debug (Total Keys: 26) #### appengine:v1beta The following keys were deleted: - resources.apps.resources.services.resources.versions.methods.exportAppImage (Total Keys: 17) - resources.projects.resources.locations.resources.applications.resources.services.resources.versions.methods.exportAppImage (Total Keys: 23) - schemas.ExportAppImageRequest (Total Keys: 4) The following keys were added: - resources.projects.resources.locations.resources.applications.resources.services.resources.versions.resources.instances.methods.debug (Total Keys: 26) - schemas.Version.properties.vpcAccess.$ref (Total Keys: 1) - schemas.Version.properties.vpcEgress.deprecated (Total Keys: 1) - schemas.VpcAccess (Total Keys: 5) - schemas.VpcEgress.deprecated (Total Keys: 1) - schemas.VpcNetworkInterface (Total Keys: 6) --- .../appengine_v1.apps.services.versions.html | 48 ----- ...ations.applications.services.versions.html | 55 +----- ...lications.services.versions.instances.html | 136 ++++++++++++++ ...pengine_v1beta.apps.services.versions.html | 104 +++++----- ...ations.applications.services.versions.html | 69 ++----- ...lications.services.versions.instances.html | 136 ++++++++++++++ .../documents/appengine.v1.json | 117 ++++-------- .../documents/appengine.v1beta.json | 177 ++++++++++-------- 8 files changed, 479 insertions(+), 363 deletions(-) create mode 100644 docs/dyn/appengine_v1.projects.locations.applications.services.versions.instances.html create mode 100644 docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.instances.html diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html index 50e670e3a7..3f6752831b 100644 --- a/docs/dyn/appengine_v1.apps.services.versions.html +++ b/docs/dyn/appengine_v1.apps.services.versions.html @@ -88,9 +88,6 @@

Instance Methods

delete(appsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing Version resource.

-

- exportAppImage(appsId, servicesId, versionsId, body=None, x__xgafv=None)

-

Exports a user image to Artifact Registry.

get(appsId, servicesId, versionsId, view=None, x__xgafv=None)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

@@ -401,51 +398,6 @@

Method Details

}
-
- exportAppImage(appsId, servicesId, versionsId, body=None, x__xgafv=None) -
Exports a user image to Artifact Registry.
-
-Args:
-  appsId: string, Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version} (required)
-  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
-  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for Versions.ExportAppImage.
-  "destinationRepository": "A String", # Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.
-  "serviceAccount": "A String", # Optional. Optional: A service account to use for authenticating to Artifact Registry.
-}
-
-  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(appsId, servicesId, versionsId, view=None, x__xgafv=None)
Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html
index 248a7a22c4..c3bb5f7fbf 100644
--- a/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html
+++ b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.html
@@ -74,15 +74,17 @@
 
 

App Engine Admin API . projects . locations . applications . services . versions

Instance Methods

+

+ instances() +

+

Returns the instances Resource.

+

close()

Close httplib2 connections.

delete(projectsId, locationsId, applicationsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing Version resource.

-

- exportAppImage(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, x__xgafv=None)

-

Exports a user image to Artifact Registry.

patch(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)

@@ -131,53 +133,6 @@

Method Details

}
-
- exportAppImage(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, x__xgafv=None) -
Exports a user image to Artifact Registry.
-
-Args:
-  projectsId: string, Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version} (required)
-  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
-  versionsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for Versions.ExportAppImage.
-  "destinationRepository": "A String", # Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.
-  "serviceAccount": "A String", # Optional. Optional: A service account to use for authenticating to Artifact Registry.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
-
patch(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.services.versions.instances.html b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.instances.html
new file mode 100644
index 0000000000..abda137374
--- /dev/null
+++ b/docs/dyn/appengine_v1.projects.locations.applications.services.versions.instances.html
@@ -0,0 +1,136 @@
+
+
+
+

App Engine Admin API . projects . locations . applications . services . versions . instances

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ debug(projectsId, locationsId, applicationsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None)

+

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ debug(projectsId, locationsId, applicationsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None) +
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  versionsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  instancesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for Instances.DebugInstance.
+  "sshKey": "A String", # Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
+}
+
+  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/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html index fc8fb6206f..e45c4b630b 100644 --- a/docs/dyn/appengine_v1beta.apps.services.versions.html +++ b/docs/dyn/appengine_v1beta.apps.services.versions.html @@ -88,9 +88,6 @@

Instance Methods

delete(appsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing Version resource.

-

- exportAppImage(appsId, servicesId, versionsId, body=None, x__xgafv=None)

-

Exports a user image to Artifact Registry.

get(appsId, servicesId, versionsId, includeExtraData=None, view=None, x__xgafv=None)

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

@@ -341,11 +338,23 @@

Method Details

"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. + "vpcAccess": { # VPC Access settings # Enables VPC access connectivity for standard apps. + "networkInterfaces": [ # The Direct VPC configuration. Currently only single network interface is supported. + { # Network interface key message. + "network": "A String", # Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK} + "subnet": "A String", # Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME} + "tags": [ # Optional. The network tags that will be applied to this App Engine resource. + "A String", + ], + }, + ], + "vpcEgress": "A String", # The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it. + }, "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. "name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1. }, - "vpcEgress": { # Vpc Egress configuration. # Enables VPC egress connectivity for standard apps. + "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps. "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it. "networkTags": [ # The network tags to apply to the instance. { # Network tag message. @@ -428,51 +437,6 @@

Method Details

}
-
- exportAppImage(appsId, servicesId, versionsId, body=None, x__xgafv=None) -
Exports a user image to Artifact Registry.
-
-Args:
-  appsId: string, Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version} (required)
-  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
-  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for Versions.ExportAppImage.
-  "destinationRepository": "A String", # Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.
-  "serviceAccount": "A String", # Optional. Optional: A service account to use for authenticating to Artifact Registry.
-}
-
-  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(appsId, servicesId, versionsId, includeExtraData=None, view=None, x__xgafv=None)
Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
@@ -720,11 +684,23 @@ 

Method Details

"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. + "vpcAccess": { # VPC Access settings # Enables VPC access connectivity for standard apps. + "networkInterfaces": [ # The Direct VPC configuration. Currently only single network interface is supported. + { # Network interface key message. + "network": "A String", # Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK} + "subnet": "A String", # Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME} + "tags": [ # Optional. The network tags that will be applied to this App Engine resource. + "A String", + ], + }, + ], + "vpcEgress": "A String", # The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it. + }, "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. "name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1. }, - "vpcEgress": { # Vpc Egress configuration. # Enables VPC egress connectivity for standard apps. + "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps. "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it. "networkTags": [ # The network tags to apply to the instance. { # Network tag message. @@ -988,11 +964,23 @@

Method Details

"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. + "vpcAccess": { # VPC Access settings # Enables VPC access connectivity for standard apps. + "networkInterfaces": [ # The Direct VPC configuration. Currently only single network interface is supported. + { # Network interface key message. + "network": "A String", # Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK} + "subnet": "A String", # Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME} + "tags": [ # Optional. The network tags that will be applied to this App Engine resource. + "A String", + ], + }, + ], + "vpcEgress": "A String", # The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it. + }, "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. "name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1. }, - "vpcEgress": { # Vpc Egress configuration. # Enables VPC egress connectivity for standard apps. + "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps. "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it. "networkTags": [ # The network tags to apply to the instance. { # Network tag message. @@ -1259,11 +1247,23 @@

Method Details

"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. + "vpcAccess": { # VPC Access settings # Enables VPC access connectivity for standard apps. + "networkInterfaces": [ # The Direct VPC configuration. Currently only single network interface is supported. + { # Network interface key message. + "network": "A String", # Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK} + "subnet": "A String", # Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME} + "tags": [ # Optional. The network tags that will be applied to this App Engine resource. + "A String", + ], + }, + ], + "vpcEgress": "A String", # The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it. + }, "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. "name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1. }, - "vpcEgress": { # Vpc Egress configuration. # Enables VPC egress connectivity for standard apps. + "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps. "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it. "networkTags": [ # The network tags to apply to the instance. { # Network tag message. diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html index 417d4a0668..987234bb74 100644 --- a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html @@ -74,15 +74,17 @@

App Engine Admin API . projects . locations . applications . services . versions

Instance Methods

+

+ instances() +

+

Returns the instances Resource.

+

close()

Close httplib2 connections.

delete(projectsId, locationsId, applicationsId, servicesId, versionsId, x__xgafv=None)

Deletes an existing Version resource.

-

- exportAppImage(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, x__xgafv=None)

-

Exports a user image to Artifact Registry.

patch(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)

Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)

@@ -131,53 +133,6 @@

Method Details

}
-
- exportAppImage(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, x__xgafv=None) -
Exports a user image to Artifact Registry.
-
-Args:
-  projectsId: string, Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version} (required)
-  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
-  versionsId: string, Part of `name`. See documentation of `projectsId`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for Versions.ExportAppImage.
-  "destinationRepository": "A String", # Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.
-  "serviceAccount": "A String", # Optional. Optional: A service account to use for authenticating to Artifact Registry.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
-
patch(projectsId, locationsId, applicationsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)
@@ -413,11 +368,23 @@ 

Method Details

"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. + "vpcAccess": { # VPC Access settings # Enables VPC access connectivity for standard apps. + "networkInterfaces": [ # The Direct VPC configuration. Currently only single network interface is supported. + { # Network interface key message. + "network": "A String", # Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK} + "subnet": "A String", # Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME} + "tags": [ # Optional. The network tags that will be applied to this App Engine resource. + "A String", + ], + }, + ], + "vpcEgress": "A String", # The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it. + }, "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. "name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1. }, - "vpcEgress": { # Vpc Egress configuration. # Enables VPC egress connectivity for standard apps. + "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps. "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it. "networkTags": [ # The network tags to apply to the instance. { # Network tag message. diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.instances.html b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.instances.html new file mode 100644 index 0000000000..08dcee86fa --- /dev/null +++ b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.instances.html @@ -0,0 +1,136 @@ + + + +

App Engine Admin API . projects . locations . applications . services . versions . instances

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ debug(projectsId, locationsId, applicationsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None)

+

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ debug(projectsId, locationsId, applicationsId, servicesId, versionsId, instancesId, body=None, x__xgafv=None) +
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.
+
+Args:
+  projectsId: string, Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1. (required)
+  locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  versionsId: string, Part of `name`. See documentation of `projectsId`. (required)
+  instancesId: string, Part of `name`. See documentation of `projectsId`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for Instances.DebugInstance.
+  "sshKey": "A String", # Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 6557c5a05d..af3ab407cd 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1301,47 +1301,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportAppImage": { -"description": "Exports a user image to Artifact Registry.", -"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"httpMethod": "POST", -"id": "appengine.apps.services.versions.exportAppImage", -"parameterOrder": [ -"appsId", -"servicesId", -"versionsId" -], -"parameters": { -"appsId": { -"description": "Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version}", -"location": "path", -"required": true, -"type": "string" -}, -"servicesId": { -"description": "Part of `name`. See documentation of `appsId`.", -"location": "path", -"required": true, -"type": "string" -}, -"versionsId": { -"description": "Part of `name`. See documentation of `appsId`.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"request": { -"$ref": "ExportAppImageRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", @@ -2499,11 +2458,11 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportAppImage": { -"description": "Exports a user image to Artifact Registry.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"httpMethod": "POST", -"id": "appengine.projects.locations.applications.services.versions.exportAppImage", +"patch": { +"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.services.versions.patch", "parameterOrder": [ "projectsId", "locationsId", @@ -2525,7 +2484,7 @@ "type": "string" }, "projectsId": { -"description": "Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version}", +"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", "location": "path", "required": true, "type": "string" @@ -2536,6 +2495,12 @@ "required": true, "type": "string" }, +"updateMask": { +"description": "Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, "versionsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2543,9 +2508,9 @@ "type": "string" } }, -"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", "request": { -"$ref": "ExportAppImageRequest" +"$ref": "Version" }, "response": { "$ref": "Operation" @@ -2553,18 +2518,23 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"patch": { -"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", -"httpMethod": "PATCH", -"id": "appengine.projects.locations.applications.services.versions.patch", +"resources": { +"instances": { +"methods": { +"debug": { +"description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", +"httpMethod": "POST", +"id": "appengine.projects.locations.applications.services.versions.instances.debug", "parameterOrder": [ "projectsId", "locationsId", "applicationsId", "servicesId", -"versionsId" +"versionsId", +"instancesId" ], "parameters": { "applicationsId": { @@ -2573,6 +2543,12 @@ "required": true, "type": "string" }, +"instancesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, "locationsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2580,7 +2556,7 @@ "type": "string" }, "projectsId": { -"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", +"description": "Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", "location": "path", "required": true, "type": "string" @@ -2591,12 +2567,6 @@ "required": true, "type": "string" }, -"updateMask": { -"description": "Standard field mask for the set of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, "versionsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2604,9 +2574,9 @@ "type": "string" } }, -"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", +"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", "request": { -"$ref": "Version" +"$ref": "DebugInstanceRequest" }, "response": { "$ref": "Operation" @@ -2625,8 +2595,10 @@ } } } +} +} }, -"revision": "20251208", +"revision": "20260113", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3324,21 +3296,6 @@ }, "type": "object" }, -"ExportAppImageRequest": { -"description": "Request message for Versions.ExportAppImage.", -"id": "ExportAppImageRequest", -"properties": { -"destinationRepository": { -"description": "Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.", -"type": "string" -}, -"serviceAccount": { -"description": "Optional. Optional: A service account to use for authenticating to Artifact Registry.", -"type": "string" -} -}, -"type": "object" -}, "FeatureSettings": { "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", "id": "FeatureSettings", diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 23f93a565b..9135ebdd35 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1316,47 +1316,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportAppImage": { -"description": "Exports a user image to Artifact Registry.", -"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"httpMethod": "POST", -"id": "appengine.apps.services.versions.exportAppImage", -"parameterOrder": [ -"appsId", -"servicesId", -"versionsId" -], -"parameters": { -"appsId": { -"description": "Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version}", -"location": "path", -"required": true, -"type": "string" -}, -"servicesId": { -"description": "Part of `name`. See documentation of `appsId`.", -"location": "path", -"required": true, -"type": "string" -}, -"versionsId": { -"description": "Part of `name`. See documentation of `appsId`.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"request": { -"$ref": "ExportAppImageRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", @@ -2612,11 +2571,11 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportAppImage": { -"description": "Exports a user image to Artifact Registry.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", -"httpMethod": "POST", -"id": "appengine.projects.locations.applications.services.versions.exportAppImage", +"patch": { +"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", +"httpMethod": "PATCH", +"id": "appengine.projects.locations.applications.services.versions.patch", "parameterOrder": [ "projectsId", "locationsId", @@ -2638,7 +2597,7 @@ "type": "string" }, "projectsId": { -"description": "Part of `name`. Required. Name of the App Engine version resource. Format: apps/{app}/services/{service}/versions/{version}", +"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", "location": "path", "required": true, "type": "string" @@ -2649,6 +2608,12 @@ "required": true, "type": "string" }, +"updateMask": { +"description": "Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, "versionsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2656,9 +2621,9 @@ "type": "string" } }, -"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}:exportAppImage", +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", "request": { -"$ref": "ExportAppImageRequest" +"$ref": "Version" }, "response": { "$ref": "Operation" @@ -2666,18 +2631,23 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"patch": { -"description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", -"httpMethod": "PATCH", -"id": "appengine.projects.locations.applications.services.versions.patch", +"resources": { +"instances": { +"methods": { +"debug": { +"description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", +"httpMethod": "POST", +"id": "appengine.projects.locations.applications.services.versions.instances.debug", "parameterOrder": [ "projectsId", "locationsId", "applicationsId", "servicesId", -"versionsId" +"versionsId", +"instancesId" ], "parameters": { "applicationsId": { @@ -2686,6 +2656,12 @@ "required": true, "type": "string" }, +"instancesId": { +"description": "Part of `name`. See documentation of `projectsId`.", +"location": "path", +"required": true, +"type": "string" +}, "locationsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2693,7 +2669,7 @@ "type": "string" }, "projectsId": { -"description": "Part of `name`. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", +"description": "Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", "location": "path", "required": true, "type": "string" @@ -2704,12 +2680,6 @@ "required": true, "type": "string" }, -"updateMask": { -"description": "Standard field mask for the set of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, "versionsId": { "description": "Part of `name`. See documentation of `projectsId`.", "location": "path", @@ -2717,9 +2687,9 @@ "type": "string" } }, -"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}", +"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", "request": { -"$ref": "Version" +"$ref": "DebugInstanceRequest" }, "response": { "$ref": "Operation" @@ -2733,6 +2703,8 @@ } } } +} +} }, "operations": { "methods": { @@ -2837,7 +2809,7 @@ } } }, -"revision": "20251210", +"revision": "20260113", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3586,21 +3558,6 @@ }, "type": "object" }, -"ExportAppImageRequest": { -"description": "Request message for Versions.ExportAppImage.", -"id": "ExportAppImageRequest", -"properties": { -"destinationRepository": { -"description": "Optional. The full resource name of the AR repository to export to. Format: projects/{project}/locations/{location}/repositories/{repository} If not specified, defaults to projects/{project}/locations/{location}/repositories/gae-standard in the same region as the app. The default repository will be created if it does not exist.", -"type": "string" -}, -"serviceAccount": { -"description": "Optional. Optional: A service account to use for authenticating to Artifact Registry.", -"type": "string" -} -}, -"type": "object" -}, "FeatureSettings": { "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", "id": "FeatureSettings", @@ -5525,13 +5482,18 @@ true "description": "Whether to deploy this version in a container on a virtual machine.", "type": "boolean" }, +"vpcAccess": { +"$ref": "VpcAccess", +"description": "Enables VPC access connectivity for standard apps." +}, "vpcAccessConnector": { "$ref": "VpcAccessConnector", "description": "Enables VPC connectivity for standard apps." }, "vpcEgress": { "$ref": "VpcEgress", -"description": "Enables VPC egress connectivity for standard apps." +"deprecated": true, +"description": "Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps." }, "zones": { "description": "The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.", @@ -5563,6 +5525,34 @@ true }, "type": "object" }, +"VpcAccess": { +"description": "VPC Access settings", +"id": "VpcAccess", +"properties": { +"networkInterfaces": { +"description": "The Direct VPC configuration. Currently only single network interface is supported.", +"items": { +"$ref": "VpcNetworkInterface" +}, +"type": "array" +}, +"vpcEgress": { +"description": "The traffic egress setting for the VPC network interface, controlling what traffic is diverted through it.", +"enum": [ +"VPC_EGRESS_UNSPECIFIED", +"ALL_TRAFFIC", +"PRIVATE_IP_RANGES" +], +"enumDescriptions": [ +"No value set; apply default behavior", +"Force all traffic to egress through the NetworkInterface (and configured VPC Network)", +"Force all Private IP Space traffic to egress through NetworkInterface (and configured VPC Network)" +], +"type": "string" +} +}, +"type": "object" +}, "VpcAccessConnector": { "description": "VPC access connector specification.", "id": "VpcAccessConnector", @@ -5589,7 +5579,8 @@ true "type": "object" }, "VpcEgress": { -"description": "Vpc Egress configuration.", +"deprecated": true, +"description": "Deprecated: Use VpcAccess instead. Vpc Egress configuration.", "id": "VpcEgress", "properties": { "egressSetting": { @@ -5620,6 +5611,28 @@ true }, "type": "object" }, +"VpcNetworkInterface": { +"description": "Network interface key message.", +"id": "VpcNetworkInterface", +"properties": { +"network": { +"description": "Optional. The VPC network that the App Engine resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork. Could be either a short name or a full path. e.g. {VPC_NETWORK} or projects/{HOST_PROJECT_ID}/global/networks/{VPC_NETWORK}", +"type": "string" +}, +"subnet": { +"description": "Optional. The VPC subnetwork that the App Engine resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. Could be either a short name or a full path. e.g. {SUBNET_NAME} or projects/{HOST_PROJECT_ID}/regions/{REGION}/subnetworks/{SUBNET_NAME}", +"type": "string" +}, +"tags": { +"description": "Optional. The network tags that will be applied to this App Engine resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "VpcNetworkTag": { "description": "Network tag message.", "id": "VpcNetworkTag", From 812d447949aa57d854152d66427eb435a39c64f2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 08/45] feat(artifactregistry): update the api #### artifactregistry:v1 The following keys were added: - schemas.Version.properties.fingerprints (Total Keys: 3) --- ...ations.repositories.packages.versions.html | 24 +++++++++++++++++++ .../documents/artifactregistry.v1.json | 10 +++++++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html index 2dd5bb175a..f8c428064b 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.versions.html @@ -207,6 +207,12 @@

Method Details

}, "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "fingerprints": [ # Output only. Immutable reference for the version, calculated based on the version's content. Currently we only support dirsum_sha256 hash algorithm. Additional hash algorithms may be added in the future. + { # A hash of file content. + "type": "A String", # The algorithm used to compute the hash value. + "value": "A String", # The hash value. + }, + ], "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact "a_key": "", # Properties of the object. }, @@ -253,6 +259,12 @@

Method Details

}, "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "fingerprints": [ # Output only. Immutable reference for the version, calculated based on the version's content. Currently we only support dirsum_sha256 hash algorithm. Additional hash algorithms may be added in the future. + { # A hash of file content. + "type": "A String", # The algorithm used to compute the hash value. + "value": "A String", # The hash value. + }, + ], "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact "a_key": "", # Properties of the object. }, @@ -298,6 +310,12 @@

Method Details

}, "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "fingerprints": [ # Output only. Immutable reference for the version, calculated based on the version's content. Currently we only support dirsum_sha256 hash algorithm. Additional hash algorithms may be added in the future. + { # A hash of file content. + "type": "A String", # The algorithm used to compute the hash value. + "value": "A String", # The hash value. + }, + ], "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact "a_key": "", # Properties of the object. }, @@ -326,6 +344,12 @@

Method Details

}, "createTime": "A String", # The time when the version was created. "description": "A String", # Optional. Description of the version, as specified in its metadata. + "fingerprints": [ # Output only. Immutable reference for the version, calculated based on the version's content. Currently we only support dirsum_sha256 hash algorithm. Additional hash algorithms may be added in the future. + { # A hash of file content. + "type": "A String", # The algorithm used to compute the hash value. + "value": "A String", # The hash value. + }, + ], "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact "a_key": "", # Properties of the object. }, diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 13f378a025..9b4c02f8cc 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2493,7 +2493,7 @@ } } }, -"revision": "20251201", +"revision": "20260102", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -4757,6 +4757,14 @@ false "description": "Optional. Description of the version, as specified in its metadata.", "type": "string" }, +"fingerprints": { +"description": "Output only. Immutable reference for the version, calculated based on the version's content. Currently we only support dirsum_sha256 hash algorithm. Additional hash algorithms may be added in the future.", +"items": { +"$ref": "Hash" +}, +"readOnly": true, +"type": "array" +}, "metadata": { "additionalProperties": { "description": "Properties of the object.", From 0410dcb056c47e68779c3aed863b9d0ab33f9a99 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 09/45] feat(beyondcorp): update the api #### beyondcorp:v1alpha The following keys were deleted: - resources.organizations.resources.locations.resources.global.resources.partnerTenants (Total Keys: 48) - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaGroup (Total Keys: 5) - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse (Total Keys: 6) - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata (Total Keys: 5) - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant (Total Keys: 14) --- ...dcorp_v1alpha.organizations.locations.html | 5 - .../documents/beyondcorp.v1alpha.json | 203 +----------------- 2 files changed, 1 insertion(+), 207 deletions(-) diff --git a/docs/dyn/beyondcorp_v1alpha.organizations.locations.html b/docs/dyn/beyondcorp_v1alpha.organizations.locations.html index 55d43a8267..d71a9c8005 100644 --- a/docs/dyn/beyondcorp_v1alpha.organizations.locations.html +++ b/docs/dyn/beyondcorp_v1alpha.organizations.locations.html @@ -74,11 +74,6 @@

BeyondCorp API . organizations . locations

Instance Methods

-

- global_() -

-

Returns the global_ Resource.

-

insights()

diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index d313e6622e..94b6bbfd0a 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -109,119 +109,6 @@ "resources": { "locations": { "resources": { -"global": { -"resources": { -"partnerTenants": { -"deprecated": true, -"methods": { -"delete": { -"deprecated": true, -"description": "Deletes a single PartnerTenant.", -"flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}", -"httpMethod": "DELETE", -"id": "beyondcorp.organizations.locations.global.partnerTenants.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Name of the resource.", -"location": "path", -"pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", -"required": true, -"type": "string" -}, -"requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"deprecated": true, -"description": "Gets details of a single PartnerTenant.", -"flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants/{partnerTenantsId}", -"httpMethod": "GET", -"id": "beyondcorp.organizations.locations.global.partnerTenants.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the PartnerTenant using the form: `organizations/{organization_id}/locations/global/partnerTenants/{partner_tenant_id}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/global/partnerTenants/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"deprecated": true, -"description": "Lists PartnerTenants in a given organization.", -"flatPath": "v1alpha/organizations/{organizationsId}/locations/global/partnerTenants", -"httpMethod": "GET", -"id": "beyondcorp.organizations.locations.global.partnerTenants.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter specifying constraints of a list operation. All fields in the PartnerTenant message are supported. For example, the following query will return the PartnerTenants with displayName \"test-tenant\" organizations/${ORG_ID}/locations/${LOCATION}/partnerTenants?filter=displayName=\"test-tenant\" Nested fields are also supported. The follow query will return PartnerTenants with internal_tenant_id \"1234\" organizations/${ORG_ID}/locations/${LOCATION}/partnerTenants?filter=partnerMetadata.internalTenantId=\"1234\" For more information, please refer to https://google.aip.dev/160.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The next_page_token value returned from a previous ListPartnerTenantsResponse, if any.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent organization to which the PartnerTenants belong. Format: `organizations/{organization_id}/locations/global`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/global$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/partnerTenants", -"response": { -"$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, "insights": { "methods": { "configuredInsight": { @@ -3445,7 +3332,7 @@ } } }, -"revision": "20251210", +"revision": "20260107", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -4840,57 +4727,6 @@ }, "type": "object" }, -"GoogleCloudBeyondcorpPartnerservicesV1alphaGroup": { -"deprecated": true, -"description": "Message to capture group information", -"id": "GoogleCloudBeyondcorpPartnerservicesV1alphaGroup", -"properties": { -"email": { -"description": "The group email id", -"type": "string" -}, -"id": { -"description": "Google group id", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse": { -"deprecated": true, -"description": "Message for response to listing PartnerTenants.", -"id": "GoogleCloudBeyondcorpPartnerservicesV1alphaListPartnerTenantsResponse", -"properties": { -"nextPageToken": { -"description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"partnerTenants": { -"description": "The list of PartnerTenant objects.", -"items": { -"$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata": { -"deprecated": true, -"description": "Metadata associated with PartnerTenant and is provided by the Partner.", -"id": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata", -"properties": { -"internalTenantId": { -"description": "Optional. UUID used by the Partner to refer to the PartnerTenant in their internal systems.", -"type": "string" -}, -"partnerTenantId": { -"description": "Optional. UUID used by the Partner to refer to the PartnerTenant in their internal systems.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerServiceOperationMetadata": { "deprecated": true, "description": "Represents the metadata of the long-running operation.", @@ -4936,43 +4772,6 @@ }, "type": "object" }, -"GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant": { -"deprecated": true, -"description": "Information about a BeyoncCorp Enterprise PartnerTenant.", -"id": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerTenant", -"properties": { -"createTime": { -"description": "Output only. Timestamp when the resource was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Optional. An arbitrary caller-provided name for the PartnerTenant. Cannot exceed 64 characters.", -"type": "string" -}, -"group": { -"$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaGroup", -"description": "Optional. Group information for the users enabled to use the partnerTenant. If the group information is not provided then the partnerTenant will be enabled for all users." -}, -"name": { -"description": "Output only. Unique resource name of the PartnerTenant. The name is ignored when creating PartnerTenant.", -"readOnly": true, -"type": "string" -}, -"partnerMetadata": { -"$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaPartnerMetadata", -"description": "Optional. Metadata provided by the Partner associated with PartnerTenant." -}, -"updateTime": { -"description": "Output only. Timestamp when the resource was last modified.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudBeyondcorpPartnerservicesV1mainPartnerServiceOperationMetadata": { "deprecated": true, "description": "Represents the metadata of the long-running operation.", From 5ba23cc115fdf034d90532d27e4a7c0932825ed0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 10/45] fix(bigquerydatatransfer): update the api #### bigquerydatatransfer:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/bigquerydatatransfer.v1.json | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index f15c898964..325afd5d5b 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -49,6 +49,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west6.rep.googleapis.com/", "location": "europe-west6" }, @@ -69,6 +74,16 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatatransfer.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -1488,7 +1503,7 @@ } } }, -"revision": "20251105", +"revision": "20260112", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { From 5f6650dd220442a495027c361775cbc41baa237b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 11/45] feat(bigqueryreservation): update the api #### bigqueryreservation:v1 The following keys were added: - schemas.Assignment.properties.enableGeminiInBigquery.deprecated (Total Keys: 1) --- .../bigqueryreservation_v1.projects.locations.html | 4 ++-- ....projects.locations.reservations.assignments.html | 12 ++++++------ .../documents/bigqueryreservation.v1.json | 5 +++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index 6f88247173..9eee2360b9 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -165,7 +165,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -214,7 +214,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 70343381f8..91b98f542e 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -121,7 +121,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -142,7 +142,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -239,7 +239,7 @@

Method Details

"assignments": [ # List of assignments visible to the user. { # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -291,7 +291,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -313,7 +313,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. @@ -334,7 +334,7 @@

Method Details

{ # An assignment allows a project to submit jobs of a certain type using slots from the specified reservation. "assignee": "A String", # Optional. The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. - "enableGeminiInBigquery": True or False, # Optional. This field controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. "Gemini in BigQuery" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to "Gemini in BigQuery" features. + "enableGeminiInBigquery": True or False, # Optional. Deprecated: "Gemini in BigQuery" is now available by default for all BigQuery editions and should not be explicitly set. Controls if "Gemini in BigQuery" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment. "jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index ef6c6baa2a..d1139f7b97 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1282,7 +1282,7 @@ } } }, -"revision": "20251105", +"revision": "20260109", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1294,7 +1294,8 @@ "type": "string" }, "enableGeminiInBigquery": { -"description": "Optional. This field controls if \"Gemini in BigQuery\" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment, which is not on by default. \"Gemini in BigQuery\" has a distinct compliance posture from BigQuery. If this field is set to true, the assignment job type is QUERY, and the parent reservation edition is ENTERPRISE_PLUS, then the assignment will give the grantee project/organization access to \"Gemini in BigQuery\" features.", +"deprecated": true, +"description": "Optional. Deprecated: \"Gemini in BigQuery\" is now available by default for all BigQuery editions and should not be explicitly set. Controls if \"Gemini in BigQuery\" (https://cloud.google.com/gemini/docs/bigquery/overview) features should be enabled for this reservation assignment.", "type": "boolean" }, "jobType": { From 7296f5090cd8b081960f867a9b5c7f5fbd90e357 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 12/45] feat(classroom): update the api #### classroom:v1 The following keys were added: - resources.courses.resources.studentGroups.methods.create (Total Keys: 11) - resources.courses.resources.studentGroups.methods.delete (Total Keys: 13) - resources.courses.resources.studentGroups.methods.list (Total Keys: 15) - resources.courses.resources.studentGroups.methods.patch (Total Keys: 17) - resources.courses.resources.studentGroups.resources.studentGroupMembers.methods.create (Total Keys: 14) - resources.courses.resources.studentGroups.resources.studentGroupMembers.methods.delete (Total Keys: 16) - resources.courses.resources.studentGroups.resources.studentGroupMembers.methods.list (Total Keys: 18) - schemas.ListStudentGroupMembersResponse (Total Keys: 5) - schemas.ListStudentGroupsResponse (Total Keys: 5) - schemas.StudentGroup (Total Keys: 9) --- ...courses.courseWork.studentSubmissions.html | 4 +- docs/dyn/classroom_v1.courses.html | 5 + .../classroom_v1.courses.studentGroups.html | 229 ++++++++++++ ...ses.studentGroups.studentGroupMembers.html | 192 ++++++++++ .../documents/classroom.v1.json | 337 +++++++++++++++++- 5 files changed, 763 insertions(+), 4 deletions(-) create mode 100644 docs/dyn/classroom_v1.courses.studentGroups.html create mode 100644 docs/dyn/classroom_v1.courses.studentGroups.studentGroupMembers.html diff --git a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html index 3daeb37bba..268f826757 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html +++ b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html @@ -82,7 +82,7 @@

Instance Methods

Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.

list(courseId, courseWorkId, late=None, pageSize=None, pageToken=None, states=None, userId=None, x__xgafv=None)

-

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

+

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

list_next()

Retrieves the next page of results.

@@ -207,7 +207,7 @@

Method Details

list(courseId, courseWorkId, late=None, pageSize=None, pageToken=None, states=None, userId=None, x__xgafv=None) -
Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
+  
Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
 
 Args:
   courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index 9e3381d3e5..f354fe10e3 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -99,6 +99,11 @@ 

Instance Methods

Returns the posts Resource.

+

+ studentGroups() +

+

Returns the studentGroups Resource.

+

students()

diff --git a/docs/dyn/classroom_v1.courses.studentGroups.html b/docs/dyn/classroom_v1.courses.studentGroups.html new file mode 100644 index 0000000000..d7a7c8fbb8 --- /dev/null +++ b/docs/dyn/classroom_v1.courses.studentGroups.html @@ -0,0 +1,229 @@ + + + +

Google Classroom API . courses . studentGroups

+

Instance Methods

+

+ studentGroupMembers() +

+

Returns the studentGroupMembers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a student group for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or for access errors. * `NOT_FOUND` if the course does not exist or the requesting user doesn't have access to the course. * `FAILED_PRECONDITION` if creating the student group would exceed the maximum number of student groups per course.

+

+ delete(courseId, id, x__xgafv=None)

+

Deletes a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.

+

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

+

Returns a list of groups in a course. This method returns the following error codes: * `NOT_FOUND` if the course does not exist.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(courseId, id, body=None, updateMask=None, x__xgafv=None)

+

Updates one or more fields in a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(courseId, body=None, x__xgafv=None) +
Creates a student group for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or for access errors. * `NOT_FOUND` if the course does not exist or the requesting user doesn't have access to the course. * `FAILED_PRECONDITION` if creating the student group would exceed the maximum number of student groups per course.
+
+Args:
+  courseId: string, Required. The identifier of the course. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A student group in a course.
+  "courseId": "A String", # The identifier of the course.
+  "id": "A String", # The identifier of the student group.
+  "title": "A String", # The title of the student group.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A student group in a course.
+  "courseId": "A String", # The identifier of the course.
+  "id": "A String", # The identifier of the student group.
+  "title": "A String", # The title of the student group.
+}
+
+ +
+ delete(courseId, id, x__xgafv=None) +
Deletes a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.
+
+Args:
+  courseId: string, Required. The identifier of the course containing the student group to delete. (required)
+  id: string, Required. The identifier of the student group 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); }
+}
+
+ +
+ list(courseId, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of groups in a course. This method returns the following error codes: * `NOT_FOUND` if the course does not exist.
+
+Args:
+  courseId: string, Required. The identifier of the course. (required)
+  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum, which is currently set to 75 items. The server may return fewer than the specified number of results.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response when listing student groups.
+  "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+  "studentGroups": [ # The student groups.
+    { # A student group in a course.
+      "courseId": "A String", # The identifier of the course.
+      "id": "A String", # The identifier of the student group.
+      "title": "A String", # The title of the student group.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(courseId, id, body=None, updateMask=None, x__xgafv=None) +
Updates one or more fields in a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.
+
+Args:
+  courseId: string, Required. Identifier of the course. (required)
+  id: string, Required. Identifier of the student group. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A student group in a course.
+  "courseId": "A String", # The identifier of the course.
+  "id": "A String", # The identifier of the student group.
+  "title": "A String", # The title of the student group.
+}
+
+  updateMask: string, Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: * `title`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A student group in a course.
+  "courseId": "A String", # The identifier of the course.
+  "id": "A String", # The identifier of the student group.
+  "title": "A String", # The title of the student group.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/classroom_v1.courses.studentGroups.studentGroupMembers.html b/docs/dyn/classroom_v1.courses.studentGroups.studentGroupMembers.html new file mode 100644 index 0000000000..fdbefbd928 --- /dev/null +++ b/docs/dyn/classroom_v1.courses.studentGroups.studentGroupMembers.html @@ -0,0 +1,192 @@ + + + +

Google Classroom API . courses . studentGroups . studentGroupMembers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(courseId, studentGroupId, body=None, x__xgafv=None)

+

Creates a student group member for a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or member for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `ALREADY_EXISTS` if the student group member already exists. * `FAILED_PRECONDITION` if attempting to add a member to a student group that has reached its member limit.

+

+ delete(courseId, studentGroupId, userId, x__xgafv=None)

+

Deletes a student group member. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group member or for access errors. * `NOT_FOUND` if the student group member does not exist or the user does not have access to the student group.

+

+ list(courseId, studentGroupId, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of students in a group. This method returns the following error codes: * `NOT_FOUND` if the course or student group does not exist.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(courseId, studentGroupId, body=None, x__xgafv=None) +
Creates a student group member for a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or member for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `ALREADY_EXISTS` if the student group member already exists. * `FAILED_PRECONDITION` if attempting to add a member to a student group that has reached its member limit.
+
+Args:
+  courseId: string, Required. The identifier of the course. (required)
+  studentGroupId: string, Required. The identifier of the student group. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A student member in a student group.
+  "courseId": "A String", # The identifier of the course.
+  "studentGroupId": "A String", # The identifier of the student group.
+  "userId": "A String", # Identifier of the student.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A student member in a student group.
+  "courseId": "A String", # The identifier of the course.
+  "studentGroupId": "A String", # The identifier of the student group.
+  "userId": "A String", # Identifier of the student.
+}
+
+ +
+ delete(courseId, studentGroupId, userId, x__xgafv=None) +
Deletes a student group member. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group member or for access errors. * `NOT_FOUND` if the student group member does not exist or the user does not have access to the student group.
+
+Args:
+  courseId: string, Required. The identifier of the course containing the relevant student group. (required)
+  studentGroupId: string, Required. The identifier of the student group containing the student group member to delete. (required)
+  userId: string, Required. The identifier of the student group member 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); }
+}
+
+ +
+ list(courseId, studentGroupId, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of students in a group. This method returns the following error codes: * `NOT_FOUND` if the course or student group does not exist.
+
+Args:
+  courseId: string, Required. The identifier of the course. (required)
+  studentGroupId: string, Required. The identifier of the student group. (required)
+  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response when listing students in a group.
+  "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+  "studentGroupMembers": [ # The student group members.
+    { # A student member in a student group.
+      "courseId": "A String", # The identifier of the course.
+      "studentGroupId": "A String", # The identifier of the student group.
+      "userId": "A String", # Identifier of the student.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index d2c52fd5b6..d1237f8e1a 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -1973,7 +1973,7 @@ ] }, "list": { -"description": "Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", +"description": "Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. A hyphen (`-`) may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", "httpMethod": "GET", "id": "classroom.courses.courseWork.studentSubmissions.list", @@ -3175,6 +3175,265 @@ } } }, +"studentGroups": { +"methods": { +"create": { +"description": "Creates a student group for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or for access errors. * `NOT_FOUND` if the course does not exist or the requesting user doesn't have access to the course. * `FAILED_PRECONDITION` if creating the student group would exceed the maximum number of student groups per course.", +"flatPath": "v1/courses/{courseId}/studentGroups", +"httpMethod": "POST", +"id": "classroom.courses.studentGroups.create", +"parameterOrder": [ +"courseId" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups", +"request": { +"$ref": "StudentGroup" +}, +"response": { +"$ref": "StudentGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters" +] +}, +"delete": { +"description": "Deletes a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.", +"flatPath": "v1/courses/{courseId}/studentGroups/{id}", +"httpMethod": "DELETE", +"id": "classroom.courses.studentGroups.delete", +"parameterOrder": [ +"courseId", +"id" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course containing the student group to delete.", +"location": "path", +"required": true, +"type": "string" +}, +"id": { +"description": "Required. The identifier of the student group to delete.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups/{id}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters" +] +}, +"list": { +"description": "Returns a list of groups in a course. This method returns the following error codes: * `NOT_FOUND` if the course does not exist.", +"flatPath": "v1/courses/{courseId}/studentGroups", +"httpMethod": "GET", +"id": "classroom.courses.studentGroups.list", +"parameterOrder": [ +"courseId" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course.", +"location": "path", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum, which is currently set to 75 items. The server may return fewer than the specified number of results.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups", +"response": { +"$ref": "ListStudentGroupsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters", +"https://www.googleapis.com/auth/classroom.rosters.readonly" +] +}, +"patch": { +"description": "Updates one or more fields in a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.", +"flatPath": "v1/courses/{courseId}/studentGroups/{id}", +"httpMethod": "PATCH", +"id": "classroom.courses.studentGroups.patch", +"parameterOrder": [ +"courseId", +"id" +], +"parameters": { +"courseId": { +"description": "Required. Identifier of the course.", +"location": "path", +"required": true, +"type": "string" +}, +"id": { +"description": "Required. Identifier of the student group.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: * `title`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups/{id}", +"request": { +"$ref": "StudentGroup" +}, +"response": { +"$ref": "StudentGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters" +] +} +}, +"resources": { +"studentGroupMembers": { +"methods": { +"create": { +"description": "Creates a student group member for a student group. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the student group or member for access errors. * `NOT_FOUND` if the student group does not exist or the user does not have access to the student group. * `ALREADY_EXISTS` if the student group member already exists. * `FAILED_PRECONDITION` if attempting to add a member to a student group that has reached its member limit.", +"flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", +"httpMethod": "POST", +"id": "classroom.courses.studentGroups.studentGroupMembers.create", +"parameterOrder": [ +"courseId", +"studentGroupId" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course.", +"location": "path", +"required": true, +"type": "string" +}, +"studentGroupId": { +"description": "Required. The identifier of the student group.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", +"request": { +"$ref": "StudentGroupMember" +}, +"response": { +"$ref": "StudentGroupMember" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters" +] +}, +"delete": { +"description": "Deletes a student group member. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested student group member or for access errors. * `NOT_FOUND` if the student group member does not exist or the user does not have access to the student group.", +"flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}", +"httpMethod": "DELETE", +"id": "classroom.courses.studentGroups.studentGroupMembers.delete", +"parameterOrder": [ +"courseId", +"studentGroupId", +"userId" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course containing the relevant student group.", +"location": "path", +"required": true, +"type": "string" +}, +"studentGroupId": { +"description": "Required. The identifier of the student group containing the student group member to delete.", +"location": "path", +"required": true, +"type": "string" +}, +"userId": { +"description": "Required. The identifier of the student group member to delete.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters" +] +}, +"list": { +"description": "Returns a list of students in a group. This method returns the following error codes: * `NOT_FOUND` if the course or student group does not exist.", +"flatPath": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", +"httpMethod": "GET", +"id": "classroom.courses.studentGroups.studentGroupMembers.list", +"parameterOrder": [ +"courseId", +"studentGroupId" +], +"parameters": { +"courseId": { +"description": "Required. The identifier of the course.", +"location": "path", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.", +"location": "query", +"type": "string" +}, +"studentGroupId": { +"description": "Required. The identifier of the student group.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers", +"response": { +"$ref": "ListStudentGroupMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/classroom.rosters", +"https://www.googleapis.com/auth/classroom.rosters.readonly" +] +} +} +} +} +}, "students": { "methods": { "create": { @@ -4107,7 +4366,7 @@ } } }, -"revision": "20260106", +"revision": "20260111", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -5514,6 +5773,42 @@ }, "type": "object" }, +"ListStudentGroupMembersResponse": { +"description": "Response when listing students in a group.", +"id": "ListStudentGroupMembersResponse", +"properties": { +"nextPageToken": { +"description": "Token identifying the next page of results to return. If empty, no further results are available.", +"type": "string" +}, +"studentGroupMembers": { +"description": "The student group members.", +"items": { +"$ref": "StudentGroupMember" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListStudentGroupsResponse": { +"description": "Response when listing student groups.", +"id": "ListStudentGroupsResponse", +"properties": { +"nextPageToken": { +"description": "Token identifying the next page of results to return. If empty, no further results are available.", +"type": "string" +}, +"studentGroups": { +"description": "The student groups.", +"items": { +"$ref": "StudentGroup" +}, +"type": "array" +} +}, +"type": "object" +}, "ListStudentSubmissionsResponse": { "description": "Response when listing student submissions.", "id": "ListStudentSubmissionsResponse", @@ -5971,6 +6266,44 @@ }, "type": "object" }, +"StudentGroup": { +"description": "A student group in a course.", +"id": "StudentGroup", +"properties": { +"courseId": { +"description": "The identifier of the course.", +"type": "string" +}, +"id": { +"description": "The identifier of the student group.", +"type": "string" +}, +"title": { +"description": "The title of the student group.", +"type": "string" +} +}, +"type": "object" +}, +"StudentGroupMember": { +"description": "A student member in a student group.", +"id": "StudentGroupMember", +"properties": { +"courseId": { +"description": "The identifier of the course.", +"type": "string" +}, +"studentGroupId": { +"description": "The identifier of the student group.", +"type": "string" +}, +"userId": { +"description": "Identifier of the student.", +"type": "string" +} +}, +"type": "object" +}, "StudentSubmission": { "description": "Student submission for course work. `StudentSubmission` items are generated when a `CourseWork` item is created. Student submissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.", "id": "StudentSubmission", From c1cca5d6d4f4e1c63b13a24564e0c6130982039b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:36 +0000 Subject: [PATCH 13/45] feat(clouddeploy): update the api #### clouddeploy:v1 The following keys were added: - schemas.AutomationRun.properties.uid (Total Keys: 2) --- ...rojects.locations.deliveryPipelines.automationRuns.html | 2 ++ .../discovery_cache/documents/clouddeploy.v1.json | 7 ++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html index ade1902a80..87e0851ca7 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html @@ -343,6 +343,7 @@

Method Details

"release": "A String", # Output only. The name of the release to be promoted. "targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name. }, + "uid": "A String", # Output only. Unique identifier of the `AutomationRun`. "updateTime": "A String", # Output only. Time at which the automationRun was updated. "waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule. }
@@ -578,6 +579,7 @@

Method Details

"release": "A String", # Output only. The name of the release to be promoted. "targetId": "A String", # Output only. The ID of the target that represents the promotion stage to which the release will be promoted. The value of this field is the last segment of a target name. }, + "uid": "A String", # Output only. Unique identifier of the `AutomationRun`. "updateTime": "A String", # Output only. Time at which the automationRun was updated. "waitUntilTime": "A String", # Output only. Earliest time the `AutomationRun` will attempt to resume. Wait-time is configured by `wait` in automation rule. }, diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 8ac32b4225..0713837635 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2359,7 +2359,7 @@ } } }, -"revision": "20251210", +"revision": "20260109", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -2891,6 +2891,11 @@ true "description": "Output only. Promotes a release to a specified 'Target' as defined in a Timed Promote Release rule.", "readOnly": true }, +"uid": { +"description": "Output only. Unique identifier of the `AutomationRun`.", +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. Time at which the automationRun was updated.", "format": "google-datetime", From 568055a42b090ee9ba668f98aab6d198d37712b7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 14/45] feat(cloudkms): update the api #### cloudkms:v1 The following keys were added: - resources.projects.methods.getAutokeyConfig (Total Keys: 11) - resources.projects.methods.updateAutokeyConfig (Total Keys: 15) --- docs/dyn/cloudkms_v1.folders.html | 10 +-- docs/dyn/cloudkms_v1.projects.html | 61 +++++++++++++ .../documents/cloudkms.v1.json | 87 +++++++++++++++++-- 3 files changed, 147 insertions(+), 11 deletions(-) diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 8ecbb3c3ed..dd4306e37d 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

getAutokeyConfig(name, x__xgafv=None)

-

Returns the AutokeyConfig for a folder.

+

Returns the AutokeyConfig for a folder or project.

getKajPolicyConfig(name, x__xgafv=None)

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

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

-

Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

+

Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

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

Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -97,10 +97,10 @@

Method Details

getAutokeyConfig(name, x__xgafv=None) -
Returns the AutokeyConfig for a folder.
+  
Returns the AutokeyConfig for a folder or project.
 
 Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. (required)
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -143,7 +143,7 @@ 

Method Details

updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None) -
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
+  
Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
 
 Args:
   name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` (required)
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index c41611a37a..1fcc5488bc 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -82,6 +82,9 @@ 

Instance Methods

close()

Close httplib2 connections.

+

+ getAutokeyConfig(name, x__xgafv=None)

+

Returns the AutokeyConfig for a folder or project.

getKajPolicyConfig(name, x__xgafv=None)

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -94,6 +97,9 @@

Instance Methods

showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)

Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.

+

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

+

Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

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

Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -103,6 +109,28 @@

Method Details

Close httplib2 connections.
+
+ getAutokeyConfig(name, x__xgafv=None) +
Returns the AutokeyConfig for a folder or project.
+
+Args:
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Cloud KMS Autokey configuration for a folder.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}
+
+
getKajPolicyConfig(name, x__xgafv=None)
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
@@ -202,6 +230,39 @@ 

Method Details

}
+
+ updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None) +
Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
+
+Args:
+  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Cloud KMS Autokey configuration for a folder.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}
+
+  updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Cloud KMS Autokey configuration for a folder.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}
+
+
updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index e1dfc41e59..23c7bbf39f 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -203,7 +203,7 @@
 "folders": {
 "methods": {
 "getAutokeyConfig": {
-"description": "Returns the AutokeyConfig for a folder.",
+"description": "Returns the AutokeyConfig for a folder or project.",
 "flatPath": "v1/folders/{foldersId}/autokeyConfig",
 "httpMethod": "GET",
 "id": "cloudkms.folders.getAutokeyConfig",
@@ -212,7 +212,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.",
+"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
 "location": "path",
 "pattern": "^folders/[^/]+/autokeyConfig$",
 "required": true,
@@ -255,7 +255,7 @@
 ]
 },
 "updateAutokeyConfig": {
-"description": "Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.",
+"description": "Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.",
 "flatPath": "v1/folders/{foldersId}/autokeyConfig",
 "httpMethod": "PATCH",
 "id": "cloudkms.folders.updateAutokeyConfig",
@@ -393,6 +393,32 @@
 },
 "projects": {
 "methods": {
+"getAutokeyConfig": {
+"description": "Returns the AutokeyConfig for a folder or project.",
+"flatPath": "v1/projects/{projectsId}/autokeyConfig",
+"httpMethod": "GET",
+"id": "cloudkms.projects.getAutokeyConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/autokeyConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "AutokeyConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
 "getKajPolicyConfig": {
 "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -497,6 +523,41 @@
 "https://www.googleapis.com/auth/cloudkms"
 ]
 },
+"updateAutokeyConfig": {
+"description": "Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.",
+"flatPath": "v1/projects/{projectsId}/autokeyConfig",
+"httpMethod": "PATCH",
+"id": "cloudkms.projects.updateAutokeyConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`",
+"location": "path",
+"pattern": "^projects/[^/]+/autokeyConfig$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "AutokeyConfig"
+},
+"response": {
+"$ref": "AutokeyConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
 "updateKajPolicyConfig": {
 "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -2753,7 +2814,7 @@
 }
 }
 },
-"revision": "20251231",
+"revision": "20260108",
 "rootUrl": "https://cloudkms.googleapis.com/",
 "schemas": {
 "AddQuorumMember": {
@@ -4291,6 +4352,20 @@
 "GOOGLE_RESPONSE_TO_PRODUCTION_ALERT",
 "CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING"
 ],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+true,
+false,
+false
+],
 "enumDescriptions": [
 "Unspecified access reason.",
 "Customer-initiated support.",
@@ -4300,8 +4375,8 @@
 "Customer uses their account to perform any access to their own data which their IAM policy authorizes.",
 "Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer.",
 "No reason is expected for this key request.",
-"Customer uses their account to perform any access to their own data which their IAM policy authorizes, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.",
-"Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.",
+"Deprecated: This code is no longer generated by Google Cloud. The GOOGLE_RESPONSE_TO_PRODUCTION_ALERT justification codes available in both Key Access Justifications and Access Transparency logs provide customer-visible signals of emergency access in more precise contexts. Customer uses their account to perform any access to their own data which their IAM policy authorizes, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.",
+"Deprecated: This code is no longer generated by Google Cloud. The GOOGLE_RESPONSE_TO_PRODUCTION_ALERT justification codes available in both Key Access Justifications and Access Transparency logs provide customer-visible signals of emergency access in more precise contexts. Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.",
 "Google-initiated access to maintain system reliability.",
 "One of the following operations is being executed while simultaneously encountering an internal technical issue which prevented a more precise justification code from being generated: * Your account has been used to perform any access to your own data which your IAM policy authorizes. * An automated Google system operates on encrypted customer data which your IAM policy authorizes. * Customer-initiated Google support access. * Google-initiated support access to protect system reliability."
 ],

From bbc53245d7149e78a71d0aafa0a7f935994f6ae6 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 20 Jan 2026 07:15:37 +0000
Subject: [PATCH 15/45] feat(cloudsearch): update the api

#### cloudsearch:v1

The following keys were deleted:
- resources.query.methods.debugSearch (Total Keys: 8)
- schemas.DebugResponse (Total Keys: 7)

The following keys were added:
- resources.operations.resources.lro.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
- schemas.QueryInterpretation.properties.interpretedQueryActualResultCount (Total Keys: 2)
- schemas.QueryInterpretation.properties.interpretedQueryEstimatedResultCount (Total Keys: 2)
---
 ...loudsearch_v1.debug.datasources.items.html |   4 +-
 .../cloudsearch_v1.indexing.datasources.html  |   4 +-
 ...dsearch_v1.indexing.datasources.items.html |  22 +-
 docs/dyn/cloudsearch_v1.media.html            |   4 +-
 docs/dyn/cloudsearch_v1.operations.lro.html   |   8 +-
 docs/dyn/cloudsearch_v1.query.html            | 424 +-----------------
 docs/dyn/cloudsearch_v1.query.sources.html    |   4 +-
 .../cloudsearch_v1.settings.datasources.html  |   4 +-
 ...search_v1.settings.searchapplications.html |   4 +-
 .../documents/cloudsearch.v1.json             |  98 ++--
 10 files changed, 80 insertions(+), 496 deletions(-)

diff --git a/docs/dyn/cloudsearch_v1.debug.datasources.items.html b/docs/dyn/cloudsearch_v1.debug.datasources.items.html
index 6d8c571d30..925752b040 100644
--- a/docs/dyn/cloudsearch_v1.debug.datasources.items.html
+++ b/docs/dyn/cloudsearch_v1.debug.datasources.items.html
@@ -158,7 +158,7 @@ 

Method Details

{ "items": [ { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -324,7 +324,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.html b/docs/dyn/cloudsearch_v1.indexing.datasources.html index 1cb7dd6add..bb098bf3e7 100644 --- a/docs/dyn/cloudsearch_v1.indexing.datasources.html +++ b/docs/dyn/cloudsearch_v1.indexing.datasources.html @@ -235,7 +235,7 @@

Method Details

"isReturnable": True or False, # Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object. "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties. "isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions. - "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties) + "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/workspace/cloud-search/docs/guides/schema-guide#properties) "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. "objectPropertyOptions": { # The options for object properties. "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000. @@ -368,7 +368,7 @@

Method Details

"isReturnable": True or False, # Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object. "isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties. "isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions. - "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties) + "isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/workspace/cloud-search/docs/guides/schema-guide#properties) "name": "A String", # The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. "objectPropertyOptions": { # The options for object properties. "subobjectProperties": [ # The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000. diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html index 1b5fa8ca95..c93fe9d1bc 100644 --- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html +++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html @@ -126,7 +126,7 @@

Method Details

UNSPECIFIED - The priority is not specified in the update request. Leaving priority unspecified results in an update failure. SYNCHRONOUS - For real-time updates. ASYNCHRONOUS - For changes that are executed after the response is sent back to the caller. - version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + version: string, Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -219,7 +219,7 @@

Method Details

An object of the form: { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -385,7 +385,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }
@@ -407,7 +407,7 @@

Method Details

"allowUnknownGsuitePrincipals": True or False, # Specifies if the index request should allow Google Workspace principals that do not exist or are deleted. }, "item": { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. # The name of the item. Format: datasources/{source_id}/items/{item_id} - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -573,7 +573,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }, "mode": "A String", # Required. The RequestMode for this request. } @@ -629,7 +629,7 @@

Method Details

{ "items": [ { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -795,7 +795,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. @@ -848,7 +848,7 @@

Method Details

{ "items": [ # Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -1014,7 +1014,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }, ], }
@@ -1058,7 +1058,7 @@

Method Details

An object of the form: { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. - "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Access control list for this item. + "acl": { # Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls). # Access control list for this item. "aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType. "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100. { # Reference to a user, group, or domain. @@ -1224,7 +1224,7 @@

Method Details

], }, }, - "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). + "version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). }
diff --git a/docs/dyn/cloudsearch_v1.media.html b/docs/dyn/cloudsearch_v1.media.html index b92281cd1a..25f7daddcd 100644 --- a/docs/dyn/cloudsearch_v1.media.html +++ b/docs/dyn/cloudsearch_v1.media.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

upload(resourceName, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

-

Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.

+

Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/workspace/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.

Method Details

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

Method Details

upload(resourceName, body=None, media_body=None, media_mime_type=None, x__xgafv=None) -
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
+  
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/workspace/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
 
 Args:
   resourceName: string, Name of the media that is being downloaded. See ReadRequest.resource_name. (required)
diff --git a/docs/dyn/cloudsearch_v1.operations.lro.html b/docs/dyn/cloudsearch_v1.operations.lro.html
index 5f2ab59704..566eeb0e94 100644
--- a/docs/dyn/cloudsearch_v1.operations.lro.html
+++ b/docs/dyn/cloudsearch_v1.operations.lro.html
@@ -78,7 +78,7 @@ 

Instance Methods

close()

Close httplib2 connections.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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

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

list_next()

@@ -90,7 +90,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -98,6 +98,7 @@ 

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -129,6 +130,9 @@

Method Details

}, }, ], + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. + "A String", + ], }
diff --git a/docs/dyn/cloudsearch_v1.query.html b/docs/dyn/cloudsearch_v1.query.html index 2546246868..21ddc5c052 100644 --- a/docs/dyn/cloudsearch_v1.query.html +++ b/docs/dyn/cloudsearch_v1.query.html @@ -82,428 +82,24 @@

Instance Methods

close()

Close httplib2 connections.

-

- debugSearch(body=None, x__xgafv=None)

-

Returns Debug information for Cloud Search Query API provides the search method. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

removeActivity(body=None, x__xgafv=None)

-

Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

+

Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).

search(body=None, x__xgafv=None)

-

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

+

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).

suggest(body=None, x__xgafv=None)

-

Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

+

Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).

Method Details

close()
Close httplib2 connections.
-
- debugSearch(body=None, x__xgafv=None) -
Returns Debug information for Cloud Search Query API provides the search method. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
-
-Args:
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The search API request. NEXT ID: 17
-  "contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.
-    { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
-      "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
-      "values": [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
-        "A String",
-      ],
-    },
-  ],
-  "dataSourceRestrictions": [ # The sources to use for querying. If not specified, all data sources from the current search application are used.
-    { # Restriction on Datasource.
-      "filterOptions": [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: "objecttype", "type" and "mimetype". For now, schema specific filters cannot be used to filter suggestions.
-        { # Filter options to be applied on query.
-          "filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
-            "compositeFilter": {
-              "logicOperator": "A String", # The logic operator of the sub filter.
-              "subFilters": [ # Sub filters.
-                # Object with schema name: Filter
-              ],
-            },
-            "valueFilter": {
-              "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
-              "value": { # Definition of a single value with generic type. # The value to be compared with.
-                "booleanValue": True or False,
-                "dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
-                  "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
-                  "month": 42, # Month of date. Must be from 1 to 12.
-                  "year": 42, # Year of date. Must be from 1 to 9999.
-                },
-                "doubleValue": 3.14,
-                "integerValue": "A String",
-                "stringValue": "A String",
-                "timestampValue": "A String",
-              },
-            },
-          },
-          "objectType": "A String", # If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
-        },
-      ],
-      "source": { # Defines sources for the suggest/search APIs. # The source of restriction.
-        "name": "A String", # Source name for content indexed by the Indexing API.
-        "predefinedSource": "A String", # Predefined content source for Google Apps.
-      },
-    },
-  ],
-  "facetOptions": [
-    { # Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
-      "integerFacetingOptions": { # Used to specify integer faceting options. # If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets.
-        "integerBuckets": [ # Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
-          "A String",
-        ],
-      },
-      "numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.
-      "objectType": "A String", # If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
-      "operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
-      "sourceName": "A String", # Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
-    },
-  ],
-  "pageSize": 42, # Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.
-  "query": "A String", # The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)
-  "queryInterpretationOptions": { # Options to interpret user query. # Options to interpret the user query.
-    "disableNlInterpretation": True or False, # Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
-    "disableSupplementalResults": True or False, # Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.
-    "enableVerbatimMode": True or False, # Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.
-  },
-  "requestOptions": { # Shared request options for all RPC methods. # Request options, such as the search application and user timezone.
-    "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Debug options of the request
-      "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
-    },
-    "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.
-    "searchApplicationId": "A String", # The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).
-    "timeZone": "A String", # Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
-  },
-  "sortOptions": { # The options for sorting the search results
-    "operatorName": "A String", # The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
-    "sortOrder": "A String", # Ascending is the default sort order
-  },
-  "start": 42, # Starting index of the results.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Debug Search Response.
-  "gsrRequest": "A String", # Serialized string of GenericSearchRequest.
-  "gsrResponse": "A String", # Serialized string of GenericSearchResponse.
-  "searchResponse": { # The search API response. NEXT ID: 17 # Search response.
-    "debugInfo": { # Debugging information about the response. # Debugging information about the response.
-      "formattedDebugInfo": "A String", # General debug info formatted for display.
-    },
-    "errorInfo": { # Error information about the response. # Error information about the response.
-      "errorMessages": [
-        { # Error message per source response.
-          "errorMessage": "A String",
-          "source": { # Defines sources for the suggest/search APIs.
-            "name": "A String", # Source name for content indexed by the Indexing API.
-            "predefinedSource": "A String", # Predefined content source for Google Apps.
-          },
-        },
-      ],
-    },
-    "facetResults": [ # Repeated facet results.
-      { # Source specific facet response
-        "buckets": [ # FacetBuckets for values in response containing at least a single result with the corresponding filter.
-          { # A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
-            "count": 42, # Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.
-            "filter": { # A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. # Filter to be passed in the search request if the corresponding bucket is selected.
-              "compositeFilter": {
-                "logicOperator": "A String", # The logic operator of the sub filter.
-                "subFilters": [ # Sub filters.
-                  # Object with schema name: Filter
-                ],
-              },
-              "valueFilter": {
-                "operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
-                "value": { # Definition of a single value with generic type. # The value to be compared with.
-                  "booleanValue": True or False,
-                  "dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
-                    "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
-                    "month": 42, # Month of date. Must be from 1 to 12.
-                    "year": 42, # Year of date. Must be from 1 to 9999.
-                  },
-                  "doubleValue": 3.14,
-                  "integerValue": "A String",
-                  "stringValue": "A String",
-                  "timestampValue": "A String",
-                },
-              },
-            },
-            "percentage": 42, # Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.
-            "value": { # Definition of a single value with generic type.
-              "booleanValue": True or False,
-              "dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
-                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
-                "month": 42, # Month of date. Must be from 1 to 12.
-                "year": 42, # Year of date. Must be from 1 to 9999.
-              },
-              "doubleValue": 3.14,
-              "integerValue": "A String",
-              "stringValue": "A String",
-              "timestampValue": "A String",
-            },
-          },
-        ],
-        "objectType": "A String", # Object type for which facet results are returned. Can be empty.
-        "operatorName": "A String", # The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions
-        "sourceName": "A String", # Source name for which facet results are returned. Will not be empty.
-      },
-    ],
-    "hasMoreResults": True or False, # Whether there are more search results matching the query.
-    "queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation is disabled.
-      "interpretationType": "A String",
-      "interpretedQuery": "A String", # The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
-      "reason": "A String", # The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.
-    },
-    "resultCountEstimate": "A String", # The estimated result count for this query.
-    "resultCountExact": "A String", # The exact result count for this query.
-    "resultCounts": { # Result count information # Expanded result count information.
-      "sourceResultCounts": [ # Result count information for each source with results.
-        { # Per source result count information.
-          "hasMoreResults": True or False, # Whether there are more search results for this source.
-          "resultCountEstimate": "A String", # The estimated result count for this source.
-          "resultCountExact": "A String", # The exact result count for this source.
-          "source": { # Defines sources for the suggest/search APIs. # The source the result count information is associated with.
-            "name": "A String", # Source name for content indexed by the Indexing API.
-            "predefinedSource": "A String", # Predefined content source for Google Apps.
-          },
-        },
-      ],
-    },
-    "results": [ # Results from a search query.
-      { # Results containing indexed information for a document.
-        "clusteredResults": [ # If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.
-          # Object with schema name: SearchResult
-        ],
-        "debugInfo": { # Debugging information about the result. # Debugging information about this search result.
-          "formattedDebugInfo": "A String", # General debug info formatted for display.
-        },
-        "metadata": { # Metadata of a matched search result. # Metadata of the search result.
-          "createTime": "A String", # The creation time for this document or object in the search result.
-          "displayOptions": { # Options that specify how to display a structured data search result.
-            "metalines": [ # The metalines content to be displayed with the result.
-              { # The collection of fields that make up a displayed line
-                "fields": [
-                  { # Display Fields for Search Results
-                    "label": "A String", # The display label for the property.
-                    "operatorName": "A String", # The operator name of the property.
-                    "property": { # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`. # The name value pair for the property.
-                      "booleanValue": True or False,
-                      "dateValues": { # List of date values.
-                        "values": [
-                          { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
-                            "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
-                            "month": 42, # Month of date. Must be from 1 to 12.
-                            "year": 42, # Year of date. Must be from 1 to 9999.
-                          },
-                        ],
-                      },
-                      "doubleValues": { # List of double values.
-                        "values": [
-                          3.14,
-                        ],
-                      },
-                      "enumValues": { # List of enum values.
-                        "values": [ # The maximum allowable length for string values is 32 characters.
-                          "A String",
-                        ],
-                      },
-                      "htmlValues": { # List of html values.
-                        "values": [ # The maximum allowable length for html values is 2048 characters.
-                          "A String",
-                        ],
-                      },
-                      "integerValues": { # List of integer values.
-                        "values": [
-                          "A String",
-                        ],
-                      },
-                      "name": "A String", # The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
-                      "objectValues": { # List of object values.
-                        "values": [
-                          # Object with schema name: StructuredDataObject
-                        ],
-                      },
-                      "textValues": { # List of text values.
-                        "values": [ # The maximum allowable length for text values is 2048 characters.
-                          "A String",
-                        ],
-                      },
-                      "timestampValues": { # List of timestamp values.
-                        "values": [
-                          "A String",
-                        ],
-                      },
-                    },
-                  },
-                ],
-              },
-            ],
-            "objectTypeLabel": "A String", # The display label for the object.
-          },
-          "fields": [ # Indexed fields in structured data, returned as a generic named property.
-            { # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
-              "booleanValue": True or False,
-              "dateValues": { # List of date values.
-                "values": [
-                  { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
-                    "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
-                    "month": 42, # Month of date. Must be from 1 to 12.
-                    "year": 42, # Year of date. Must be from 1 to 9999.
-                  },
-                ],
-              },
-              "doubleValues": { # List of double values.
-                "values": [
-                  3.14,
-                ],
-              },
-              "enumValues": { # List of enum values.
-                "values": [ # The maximum allowable length for string values is 32 characters.
-                  "A String",
-                ],
-              },
-              "htmlValues": { # List of html values.
-                "values": [ # The maximum allowable length for html values is 2048 characters.
-                  "A String",
-                ],
-              },
-              "integerValues": { # List of integer values.
-                "values": [
-                  "A String",
-                ],
-              },
-              "name": "A String", # The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
-              "objectValues": { # List of object values.
-                "values": [
-                  # Object with schema name: StructuredDataObject
-                ],
-              },
-              "textValues": { # List of text values.
-                "values": [ # The maximum allowable length for text values is 2048 characters.
-                  "A String",
-                ],
-              },
-              "timestampValues": { # List of timestamp values.
-                "values": [
-                  "A String",
-                ],
-              },
-            },
-          ],
-          "mimeType": "A String", # Mime type of the search result.
-          "objectType": "A String", # Object type of the search result.
-          "owner": { # Object to represent a person. # Owner (usually creator) of the document or object of the search result.
-            "emailAddresses": [ # The person's email addresses
-              { # A person's email address.
-                "customType": "A String", # If the value of type is custom, this property contains the custom type string.
-                "emailAddress": "A String", # The email address.
-                "emailUrl": "A String", # The URL to send email.
-                "primary": True or False, # Indicates if this is the user's primary email. Only one entry can be marked as primary.
-                "type": "A String", # The type of the email account. Acceptable values are: "custom", "home", "other", "work".
-              },
-            ],
-            "name": "A String", # The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.
-            "obfuscatedId": "A String", # Obfuscated ID of a person.
-            "personNames": [ # The person's name
-              { # A person's name.
-                "displayName": "A String", # The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
-              },
-            ],
-            "phoneNumbers": [ # The person's phone numbers
-              { # A person's Phone Number
-                "phoneNumber": "A String", # The phone number of the person.
-                "type": "A String",
-              },
-            ],
-            "photos": [ # A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.
-              { # A person's photo.
-                "url": "A String", # The URL of the photo.
-              },
-            ],
-          },
-          "source": { # Defines sources for the suggest/search APIs. # The named source for the result, such as Gmail.
-            "name": "A String", # Source name for content indexed by the Indexing API.
-            "predefinedSource": "A String", # Predefined content source for Google Apps.
-          },
-          "thumbnailUrl": "A String", # The thumbnail URL of the result.
-          "updateTime": "A String", # The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
-        },
-        "snippet": { # Snippet of the search result, which summarizes the content of the resulting page. # The concatenation of all snippets (summaries) available for this result.
-          "matchRanges": [ # The matched ranges in the snippet.
-            { # Matched range of a snippet [start, end).
-              "end": 42, # End of the match in the snippet.
-              "start": 42, # Starting position of the match in the snippet.
-            },
-          ],
-          "snippet": "A String", # The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.
-        },
-        "title": "A String", # Title of the search result.
-        "url": "A String", # The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.
-      },
-    ],
-    "spellResults": [ # Suggested spelling for the query.
-      {
-        "suggestedQuery": "A String", # The suggested spelling of the query.
-        "suggestedQueryHtml": { # IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. # The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked.
-          "privateDoNotAccessOrElseSafeHtmlWrappedValue": "A String", # IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.
-        },
-        "suggestionType": "A String", # Suggestion triggered for the current query.
-      },
-    ],
-    "structuredResults": [ # Structured results for the user query. These results are not counted against the page_size.
-      { # Structured results that are returned as part of search request.
-        "person": { # Object to represent a person. # Representation of a person
-          "emailAddresses": [ # The person's email addresses
-            { # A person's email address.
-              "customType": "A String", # If the value of type is custom, this property contains the custom type string.
-              "emailAddress": "A String", # The email address.
-              "emailUrl": "A String", # The URL to send email.
-              "primary": True or False, # Indicates if this is the user's primary email. Only one entry can be marked as primary.
-              "type": "A String", # The type of the email account. Acceptable values are: "custom", "home", "other", "work".
-            },
-          ],
-          "name": "A String", # The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.
-          "obfuscatedId": "A String", # Obfuscated ID of a person.
-          "personNames": [ # The person's name
-            { # A person's name.
-              "displayName": "A String", # The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.
-            },
-          ],
-          "phoneNumbers": [ # The person's phone numbers
-            { # A person's Phone Number
-              "phoneNumber": "A String", # The phone number of the person.
-              "type": "A String",
-            },
-          ],
-          "photos": [ # A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.
-            { # A person's photo.
-              "url": "A String", # The URL of the photo.
-            },
-          ],
-        },
-      },
-    ],
-  },
-}
-
-
removeActivity(body=None, x__xgafv=None) -
Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+  
Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
 
 Args:
   body: object, The request body.
@@ -539,13 +135,13 @@ 

Method Details

search(body=None, x__xgafv=None) -
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+  
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
-{ # The search API request. NEXT ID: 17
+{ # The search API request. NEXT ID: 24
   "contextAttributes": [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.
     { # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
       "name": "A String", # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
@@ -633,7 +229,7 @@ 

Method Details

Returns: An object of the form: - { # The search API response. NEXT ID: 17 + { # The search API response. NEXT ID: 19 "debugInfo": { # Debugging information about the response. # Debugging information about the response. "formattedDebugInfo": "A String", # General debug info formatted for display. }, @@ -700,6 +296,8 @@

Method Details

"queryInterpretation": { # Query interpretation result for user query. Empty if query interpretation is disabled. "interpretationType": "A String", "interpretedQuery": "A String", # The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. + "interpretedQueryActualResultCount": 42, # The actual number of results returned by the interpreted query. + "interpretedQueryEstimatedResultCount": "A String", # The estimated number of results returned by the interpreted query. "reason": "A String", # The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE. }, "resultCountEstimate": "A String", # The estimated result count for this query. @@ -718,7 +316,7 @@

Method Details

], }, "results": [ # Results from a search query. - { # Results containing indexed information for a document. + { # Results containing indexed information for a document. Next ID: 16 "clusteredResults": [ # If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty. # Object with schema name: SearchResult ], @@ -936,7 +534,7 @@

Method Details

suggest(body=None, x__xgafv=None) -
Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+  
Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
 
 Args:
   body: object, The request body.
diff --git a/docs/dyn/cloudsearch_v1.query.sources.html b/docs/dyn/cloudsearch_v1.query.sources.html
index 2923cd4820..386cf402ae 100644
--- a/docs/dyn/cloudsearch_v1.query.sources.html
+++ b/docs/dyn/cloudsearch_v1.query.sources.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

list(pageToken=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None)

-

Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).

+

Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).

list_next()

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

list(pageToken=None, requestOptions_debugOptions_enableDebugging=None, requestOptions_languageCode=None, requestOptions_searchApplicationId=None, requestOptions_timeZone=None, x__xgafv=None) -
Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
+  
Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
 
 Args:
   pageToken: string, Number of sources to return in the response.
diff --git a/docs/dyn/cloudsearch_v1.settings.datasources.html b/docs/dyn/cloudsearch_v1.settings.datasources.html
index bdb13e119e..8eae2e96c4 100644
--- a/docs/dyn/cloudsearch_v1.settings.datasources.html
+++ b/docs/dyn/cloudsearch_v1.settings.datasources.html
@@ -327,7 +327,7 @@ 

Method Details

} debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. - updateMask: string, Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. + updateMask: string, Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -391,7 +391,7 @@

Method Details

"returnThumbnailUrls": True or False, # Can a user request to get thumbnail URI for Items indexed in this data source. "shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. }, - "updateMask": "A String", # Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. + "updateMask": "A String", # Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudsearch_v1.settings.searchapplications.html b/docs/dyn/cloudsearch_v1.settings.searchapplications.html index 51d5de29a7..830d84fc53 100644 --- a/docs/dyn/cloudsearch_v1.settings.searchapplications.html +++ b/docs/dyn/cloudsearch_v1.settings.searchapplications.html @@ -585,7 +585,7 @@

Method Details

], } - updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. + updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -754,7 +754,7 @@

Method Details

], } - updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. + updateMask: string, Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index b0e623d022..0f9230db41 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -38,7 +38,7 @@ "canonicalName": "Cloud Search", "description": "Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.", "discoveryVersion": "v1", -"documentationLink": "https://developers.google.com/cloud-search/docs/guides/", +"documentationLink": "https://developers.google.com/workspace/cloud-search/docs/guides/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -521,7 +521,7 @@ "type": "string" }, "version": { -"description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", +"description": "Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations).", "format": "byte", "location": "query", "type": "string" @@ -807,7 +807,7 @@ "media": { "methods": { "upload": { -"description": "Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.", +"description": "Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/workspace/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.", "flatPath": "v1/media/{mediaId}", "httpMethod": "POST", "id": "cloudsearch.media.upload", @@ -916,6 +916,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/lro", @@ -937,27 +942,8 @@ }, "query": { "methods": { -"debugSearch": { -"description": "Returns Debug information for Cloud Search Query API provides the search method. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", -"flatPath": "v1/query:debugSearch", -"httpMethod": "POST", -"id": "cloudsearch.query.debugSearch", -"parameterOrder": [], -"parameters": {}, -"path": "v1/query:debugSearch", -"request": { -"$ref": "SearchRequest" -}, -"response": { -"$ref": "DebugResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud_search", -"https://www.googleapis.com/auth/cloud_search.query" -] -}, "removeActivity": { -"description": "Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", +"description": "Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).", "flatPath": "v1/query:removeActivity", "httpMethod": "POST", "id": "cloudsearch.query.removeActivity", @@ -976,7 +962,7 @@ ] }, "search": { -"description": "The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", +"description": "The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).", "flatPath": "v1/query/search", "httpMethod": "POST", "id": "cloudsearch.query.search", @@ -995,7 +981,7 @@ ] }, "suggest": { -"description": "Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", +"description": "Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).", "flatPath": "v1/query/suggest", "httpMethod": "POST", "id": "cloudsearch.query.suggest", @@ -1018,7 +1004,7 @@ "sources": { "methods": { "list": { -"description": "Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).", +"description": "Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).", "flatPath": "v1/query/sources", "httpMethod": "GET", "id": "cloudsearch.query.sources.list", @@ -1253,7 +1239,7 @@ "type": "string" }, "updateMask": { -"description": "Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", +"description": "Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1441,7 +1427,7 @@ "type": "string" }, "updateMask": { -"description": "Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", +"description": "Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1507,7 +1493,7 @@ "type": "string" }, "updateMask": { -"description": "Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", +"description": "Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2115,7 +2101,7 @@ } } }, -"revision": "20241113", +"revision": "20260114", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "Action": { @@ -2672,27 +2658,6 @@ }, "type": "object" }, -"DebugResponse": { -"description": "Debug Search Response.", -"id": "DebugResponse", -"properties": { -"gsrRequest": { -"description": "Serialized string of GenericSearchRequest.", -"format": "byte", -"type": "string" -}, -"gsrResponse": { -"description": "Serialized string of GenericSearchResponse.", -"format": "byte", -"type": "string" -}, -"searchResponse": { -"$ref": "SearchResponse", -"description": "Search response." -} -}, -"type": "object" -}, "DeleteQueueItemsRequest": { "id": "DeleteQueueItemsRequest", "properties": { @@ -5359,7 +5324,7 @@ false "description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." }, "version": { -"description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", +"description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations).", "format": "byte", "type": "string" } @@ -5367,7 +5332,7 @@ false "type": "object" }, "ItemAcl": { -"description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls).", +"description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/workspace/cloud-search/docs/guides/acls).", "id": "ItemAcl", "properties": { "aclInheritanceType": { @@ -5669,6 +5634,13 @@ false "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -6493,7 +6465,7 @@ false "type": "boolean" }, "isWildcardSearchable": { -"description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)", +"description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/workspace/cloud-search/docs/guides/schema-guide#properties)", "type": "boolean" }, "name": { @@ -6637,6 +6609,16 @@ false "description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.", "type": "string" }, +"interpretedQueryActualResultCount": { +"description": "The actual number of results returned by the interpreted query.", +"format": "int32", +"type": "integer" +}, +"interpretedQueryEstimatedResultCount": { +"description": "The estimated number of results returned by the interpreted query.", +"format": "int64", +"type": "string" +}, "reason": { "description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.", "enum": [ @@ -7268,7 +7250,7 @@ false "type": "object" }, "SearchRequest": { -"description": "The search API request. NEXT ID: 17", +"description": "The search API request. NEXT ID: 24", "id": "SearchRequest", "properties": { "contextAttributes": { @@ -7321,7 +7303,7 @@ false "type": "object" }, "SearchResponse": { -"description": "The search API response. NEXT ID: 17", +"description": "The search API response. NEXT ID: 19", "id": "SearchResponse", "properties": { "debugInfo": { @@ -7386,7 +7368,7 @@ false "type": "object" }, "SearchResult": { -"description": "Results containing indexed information for a document.", +"description": "Results containing indexed information for a document. Next ID: 16", "id": "SearchResult", "properties": { "clusteredResults": { @@ -7910,7 +7892,7 @@ false "$ref": "DataSource" }, "updateMask": { -"description": "Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", +"description": "Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.", "format": "google-fieldmask", "type": "string" } From 6230ed7be3d2386e6280f15cda338453134e43c5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 16/45] feat(cloudsupport): update the api #### cloudsupport:v2 The following keys were added: - schemas.Blobstore2Info.properties.uploadFragmentListCreationInfo (Total Keys: 2) #### cloudsupport:v2beta The following keys were added: - schemas.Blobstore2Info.properties.uploadFragmentListCreationInfo (Total Keys: 2) --- docs/dyn/cloudsupport_v2.media.html | 8 ++++++++ docs/dyn/cloudsupport_v2beta.media.html | 8 ++++++++ .../discovery_cache/documents/cloudsupport.v2.json | 7 ++++++- .../discovery_cache/documents/cloudsupport.v2beta.json | 7 ++++++- 4 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/dyn/cloudsupport_v2.media.html b/docs/dyn/cloudsupport_v2.media.html index 5509893486..a4b0a4df8c 100644 --- a/docs/dyn/cloudsupport_v2.media.html +++ b/docs/dyn/cloudsupport_v2.media.html @@ -116,6 +116,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "compositeMedia": [ # # gdata.* are outside protos with mising documentation @@ -127,6 +128,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -163,6 +165,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -188,6 +191,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -216,6 +220,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -242,6 +247,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -266,6 +272,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -294,6 +301,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation diff --git a/docs/dyn/cloudsupport_v2beta.media.html b/docs/dyn/cloudsupport_v2beta.media.html index d4e1e2805a..3b85587204 100644 --- a/docs/dyn/cloudsupport_v2beta.media.html +++ b/docs/dyn/cloudsupport_v2beta.media.html @@ -116,6 +116,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "compositeMedia": [ # # gdata.* are outside protos with mising documentation @@ -127,6 +128,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -163,6 +165,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -188,6 +191,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -216,6 +220,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -242,6 +247,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -266,6 +272,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation @@ -294,6 +301,7 @@

Method Details

"downloadExternalReadToken": "A String", # # gdata.* are outside protos with mising documentation "downloadReadHandle": "A String", # # gdata.* are outside protos with mising documentation "readToken": "A String", # # gdata.* are outside protos with mising documentation + "uploadFragmentListCreationInfo": "A String", # # gdata.* are outside protos with mising documentation "uploadMetadataContainer": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 77736cbfc0..e4e3bed110 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, -"revision": "20251203", +"revision": "20260113", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -646,6 +646,11 @@ "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, +"uploadFragmentListCreationInfo": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" +}, "uploadMetadataContainer": { "description": "# gdata.* are outside protos with mising documentation", "format": "byte", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index 1d87e4c77e..d5a81ed8e6 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -669,7 +669,7 @@ } } }, -"revision": "20251203", +"revision": "20260113", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -763,6 +763,11 @@ "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, +"uploadFragmentListCreationInfo": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" +}, "uploadMetadataContainer": { "description": "# gdata.* are outside protos with mising documentation", "format": "byte", From 666ac5d921a5bcbbbd2f0711a248e7716e3f3b30 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 17/45] feat(compute): update the api #### compute:alpha The following keys were deleted: - schemas.BackendService.properties.vpcNetworkScope.type (Total Keys: 1) The following keys were added: - schemas.ReservationSlot.properties.physicalTopology (Total Keys: 3) #### compute:beta The following keys were added: - resources.reservationSlots.methods.get (Total Keys: 20) - resources.reservationSlots.methods.list (Total Keys: 30) - resources.reservationSlots.methods.update (Total Keys: 24) - schemas.BulkInsertInstanceResource.properties.instanceFlexibilityPolicy.$ref (Total Keys: 1) - schemas.InstanceFlexibilityPolicy (Total Keys: 12) - schemas.ReservationSlot (Total Keys: 61) #### compute:v1 The following keys were added: - resources.reservationSlots.methods.get (Total Keys: 20) - resources.reservationSlots.methods.list (Total Keys: 30) - resources.reservationSlots.methods.update (Total Keys: 24) - schemas.BulkInsertInstanceResource.properties.instanceFlexibilityPolicy.$ref (Total Keys: 1) - schemas.InstanceFlexibilityPolicy (Total Keys: 12) - schemas.ReservationSlot (Total Keys: 61) --- docs/dyn/compute_alpha.backendServices.html | 70 -- ...te_alpha.interconnectAttachmentGroups.html | 2 + ...compute_alpha.interconnectAttachments.html | 5 + .../compute_alpha.regionBackendServices.html | 60 -- docs/dyn/compute_alpha.reservationSlots.html | 108 +-- docs/dyn/compute_beta.html | 5 + docs/dyn/compute_beta.instances.html | 512 +++++++++++++ .../compute_beta.interconnectAttachments.html | 5 + docs/dyn/compute_beta.regionInstances.html | 512 +++++++++++++ docs/dyn/compute_beta.reservationSlots.html | 696 ++++++++++++++++++ docs/dyn/compute_v1.html | 5 + docs/dyn/compute_v1.instances.html | 458 ++++++++++++ .../compute_v1.interconnectAttachments.html | 5 + docs/dyn/compute_v1.regionInstances.html | 458 ++++++++++++ docs/dyn/compute_v1.reservationSlots.html | 681 +++++++++++++++++ .../documents/compute.alpha.json | 88 +-- .../documents/compute.beta.json | 516 ++++++++++++- .../discovery_cache/documents/compute.v1.json | 518 ++++++++++++- 18 files changed, 4470 insertions(+), 234 deletions(-) create mode 100644 docs/dyn/compute_beta.reservationSlots.html create mode 100644 docs/dyn/compute_v1.reservationSlots.html diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index f2e08dc497..24fd752047 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -2286,16 +2286,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "warning": { # Informational warning which replaces the list of @@ -4699,16 +4689,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }
@@ -7658,16 +7638,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -9781,16 +9751,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#backendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services. @@ -11664,16 +11624,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#usableBackendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend @@ -13490,16 +13440,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -17011,16 +16951,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html index 26aafab52d..64405015fa 100644 --- a/docs/dyn/compute_alpha.interconnectAttachmentGroups.html +++ b/docs/dyn/compute_alpha.interconnectAttachmentGroups.html @@ -156,6 +156,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -408,6 +409,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html index f0ea3c0a24..33f1ea2f74 100644 --- a/docs/dyn/compute_alpha.interconnectAttachments.html +++ b/docs/dyn/compute_alpha.interconnectAttachments.html @@ -257,6 +257,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1021,6 +1022,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1782,6 +1784,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2540,6 +2543,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2984,6 +2988,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 6b788fa2b5..b26f804c1e 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -2159,16 +2159,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }
@@ -4345,16 +4335,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -6469,16 +6449,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#backendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services. @@ -8355,16 +8325,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. }, ], "kind": "compute#usableBackendServiceList", # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend @@ -10182,16 +10142,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -13419,16 +13369,6 @@

Method Details

# and ForwardingRule. }, ], - "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend - # service. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK. - # - # A backend service with the VPC scope set to GLOBAL_VPC_NETWORK - # is only allowed to have backends in global VPC networks. - # - # When the VPC scope is set to REGIONAL_VPC_NETWORK the backend - # service is only allowed to have backends in regional networks in the same - # scope as the backend service. - # Note: if not specified then GLOBAL_VPC_NETWORK will be used. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.reservationSlots.html b/docs/dyn/compute_alpha.reservationSlots.html index b3293912f3..ee2f5462e8 100644 --- a/docs/dyn/compute_alpha.reservationSlots.html +++ b/docs/dyn/compute_alpha.reservationSlots.html @@ -97,12 +97,12 @@

Method Details

Retrieves information about the specified reservation slot.
 
 Args:
-  project: string, Project ID for this request. (required)
-  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
-  parentName: string, The name of the parent reservation and parent block. In the format of
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
 reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
-  reservationSlot: string, The name of the reservation slot.
-Name should conform to RFC1035 or be a resource ID. (required)
+  reservationSlot: string, The name of the reservation slot, formatted as RFC1035 or a resource ID
+number. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -113,18 +113,22 @@ 

Method Details

{ "resource": { # Represents a reservation slot resource. - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format. - "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text. + "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is # defined by the server. - "kind": "compute#reservationSlot", # Output only. [Output Only] Type of the resource. Alwayscompute#reservationSlot for reservation slots. - "name": "A String", # Output only. [Output Only] The name of this reservation slot generated by - # Compute Engine. The name must be 1-63 characters long, and comply with - # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? - "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared slot. Set to empty - # to inherit share settings from a parent resource. + "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots. + "name": "A String", # Output only. [Output Only] The name of the reservation slot. + "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot. + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. + }, + "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource. + "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID. + "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty + # to inherit the share settings from a parent resource. "folderMap": { # A map of folder id and folder config to specify consumer projects for this # shared-reservation. This is only valid when share_type's value is # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. @@ -149,13 +153,14 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "state": "A String", # Output only. [Output Only] State of the reservation slot. + "state": "A String", # Output only. [Output Only] The state of the reservation slot. "status": { # Output only. [Output Only] The status of the reservation slot. - "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation subBlock. - "block": "A String", # The hash of the capacity block within the cluster. - "cluster": "A String", # The cluster name of the reservation subBlock. - "host": "A String", # The hash of the capacity host within the capacity sub-block. - "subBlock": "A String", # The hash of the capacity sub-block within the capacity block. + "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block. + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. }, "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host. "A String", @@ -164,7 +169,7 @@

Method Details

"A String", ], }, - "zone": "A String", # Output only. [Output Only] Zone in which the reservation slot resides. + "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides. }, }
@@ -174,9 +179,9 @@

Method Details

Retrieves a list of reservation slots under a single reservation.
 
 Args:
-  project: string, Project ID for this request. (required)
-  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
-  parentName: string, The name of the parent reservation and parent block. In the format of
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
 reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
   filter: string, A filter expression that filters resources listed in the response. Most
 Compute resources support two types of filter expressions:
@@ -269,22 +274,26 @@ 

Method Details

Returns: An object of the form: - { # A list of reservation slots under a single reservation. - "id": "A String", # Unique identifier for the resource; defined by the server. + { # A list of reservation slots within a single reservation. + "id": "A String", # The unique identifier for the resource; defined by the server. "items": [ # A list of reservation slot resources. { # Represents a reservation slot resource. - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format. - "description": "A String", # An optional description of this resource. - "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text. + "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is # defined by the server. - "kind": "compute#reservationSlot", # Output only. [Output Only] Type of the resource. Alwayscompute#reservationSlot for reservation slots. - "name": "A String", # Output only. [Output Only] The name of this reservation slot generated by - # Compute Engine. The name must be 1-63 characters long, and comply with - # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? - "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. - "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. - "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared slot. Set to empty - # to inherit share settings from a parent resource. + "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots. + "name": "A String", # Output only. [Output Only] The name of the reservation slot. + "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot. + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. + }, + "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource. + "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID. + "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty + # to inherit the share settings from a parent resource. "folderMap": { # A map of folder id and folder config to specify consumer projects for this # shared-reservation. This is only valid when share_type's value is # DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. @@ -309,13 +318,14 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "state": "A String", # Output only. [Output Only] State of the reservation slot. + "state": "A String", # Output only. [Output Only] The state of the reservation slot. "status": { # Output only. [Output Only] The status of the reservation slot. - "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation subBlock. - "block": "A String", # The hash of the capacity block within the cluster. - "cluster": "A String", # The cluster name of the reservation subBlock. - "host": "A String", # The hash of the capacity host within the capacity sub-block. - "subBlock": "A String", # The hash of the capacity sub-block within the capacity block. + "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block. + "block": "A String", # The unique identifier of the capacity block within the cluster. + "cluster": "A String", # The cluster name of the reservation sub-block. + "host": "A String", # The unique identifier of the capacity host within the capacity sub-block. + "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity + # block. }, "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host. "A String", @@ -324,18 +334,18 @@

Method Details

"A String", ], }, - "zone": "A String", # Output only. [Output Only] Zone in which the reservation slot resides. + "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides. }, ], - "kind": "compute#reservationSlot", # Type of the resource. Alwayscompute#reservationSlot for a list of reservation + "kind": "compute#reservationSlot", # The type of resource. Alwayscompute#reservationSlot for a list of reservation # slots. "nextPageToken": "A String", # This token allows you to get the next page of results for # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. - "selfLink": "A String", # Server-defined URL for this resource. - "warning": { # Informational warning message. + "selfLink": "A String", # The server-defined URL for this resource. + "warning": { # An informational warning message. "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute # Engine returns NO_RESULTS_ON_PAGE if there # are no results in the response. diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 262f2c4d90..c59cca65b5 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -554,6 +554,11 @@

Instance Methods

Returns the reservationBlocks Resource.

+

+ reservationSlots() +

+

Returns the reservationSlots Resource.

+

reservationSubBlocks()

diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 863fe4e250..f479a10398 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -3565,6 +3565,518 @@

Method Details

# compute.regionInstances.bulkInsert . This resource is not persisted # anywhere, it is used only for processing the requests. "count": "A String", # The maximum number of instances to create. + "instanceFlexibilityPolicy": { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create. + "instanceSelections": { # Specification of alternative, flexible instance subsets. + # One of them will be selected to create the instances + # based on various criteria, like: + # - ranks, + # - location policy, + # - current capacity, + # - available reservations (you can specify affinity in + # InstanceProperties), + # - SWAN/GOOSE limitations. + # Key is an arbitrary, unique RFC1035 string that identifies the instance + # selection. + "a_key": { # Specification of machine type to use. Every position inside this message + # is an alternative. + # The count specified in the shape flexibility must not exceed the number + # of entries in per_instance_properties or the capacity of the + # name_pattern, if used. + "disks": [ # Disks to be attached to the instances created from in this selection. + # They override the disks specified in the instance properties. + { # An instance-attached disk resource. + "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 + # or X86_64. + "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is + # deleted (but not when the disk is detached from the instance). + "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first + # partition of the disk for its root filesystem. + "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system + # running within the instance. This name can be used to reference the device + # for mounting, resizing, and so on, from within the instance. + # + # If not specified, the server chooses a default device name to apply to this + # disk, in the form persistent-disk-x, where x is a number + # assigned by Google Compute Engine. This field is only applicable for + # persistent disks. + "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied + # encryption key. + # + # If you are creating a new disk, this field encrypts the new disk using + # an encryption key that you provide. If you are attaching an existing + # disk that is already encrypted, this field decrypts the disk using + # the customer-supplied encryption key. + # + # If you encrypt a disk using a customer-supplied key, you must provide the + # same key again when you attempt to use this resource at a later time. For + # example, you must provide the key when you create a snapshot or an image + # from the disk or when you attach the disk to a virtual machine instance. + # + # If you do not provide an encryption key, then the disk will be encrypted + # using an automatically generated key and you do not need to provide a key + # to use the disk later. + # + # Note: + # + # Instance templates do not storecustomer-supplied + # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group. + # + # You cannot create VMs that have disks with customer-supplied keys using + # the bulk + # insert method. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "diskSizeGb": "A String", # The size of the disk in GB. + "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's + # currently attached to another instance. If you try to force attach a zonal + # disk to an instance, you will receive an error. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the + # boot disk. If you have many disks attached to an instance, each + # disk would have a unique index number. + "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This field is persisted and returned for instanceTemplate and not returned + # in the context of instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + "architecture": "A String", # The architecture of the attached disk. Valid values are + # arm64 or x86_64. + "description": "A String", # An optional description. Provide this property when creating the disk. + "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name + # of the instance. If a disk with the same name already exists in the given + # region, the existing disk is attached to the new instance and the + # new disk is not created. + "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least + # 10 GB. If you specify a sourceImage, which is required for + # boot disks, the default size is the size of the sourceImage. + # If you do not specify a sourceImage, the default disk size + # is 500 GB. + "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, + # the default is pd-standard, specified using the full URL. + # For example: + # + # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard + # + # + # For a full list of acceptable values, seePersistent disk + # types. If you specify this field when creating a VM, you can provide + # either the full or partial URL. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # If you specify this field when creating or updating an instance template + # or all-instances configuration, specify the type of the disk, not the + # URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + # + # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for + # persistent disks. + "a_key": "A String", + }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], + "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to + # more than one instance. + "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default + # is to use the existing disk. + "provisionedIops": "A String", # 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 10,000 and 120,000. For more details, see theExtreme persistent + # disk documentation. + "provisionedThroughput": "A String", # 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 + # greater than or equal to 1. + "replicaZones": [ # Required for each regional disk associated with the instance. Specify + # the URLs of the zones where the disk should be replicated to. + # You must provide exactly two replica zones, and one zone must be the same + # as the instance zone. + "A String", + ], + "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + # have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced + # format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when + # empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. + # Specified using the full or partial URL. For instance template, specify + # only the resource policy name. + "A String", + ], + "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot + # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # To create a disk with one of the public operating system + # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: + # + # projects/debian-cloud/global/images/family/debian-9 + # + # + # Alternatively, use a specific version of a public operating system image: + # + # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + # + # + # To create a disk with a custom image that you created, specify the + # image name in the following format: + # + # global/images/my-custom-image + # + # + # You can also specify a custom image by its image family, which returns + # the latest version of the image in that family. Replace the image name + # with family/family-name: + # + # global/images/family/my-image-family + # + # + # If the source image is deleted later, this field will not be set. + "sourceImageEncryptionKey": { # Thecustomer-supplied + # encryption key of the source image. Required if the source image is + # protected by a customer-supplied encryption key. + # + # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied + # encryption keys, so you cannot create disks for instances in a managed instance group if the + # source images are encrypted with your own keys. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new + # instance boot disk, one of initializeParams.sourceSnapshot + # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # us-central1-a/instantSnapshots/my-backup + # + # + # If the source instant-snapshot is deleted later, this field will not be + # set. + "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance + # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # global/snapshots/my-backup + # + # + # If the source snapshot is deleted later, this field will not be set. + # + # Note: You cannot create VMs in bulk using a snapshot as the source. Use + # an image instead when you create VMs using + # the bulk + # insert method. + "sourceSnapshotEncryptionKey": { # Thecustomer-supplied + # encryption key of the source snapshot. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "storagePool": "A String", # The storage pool in which the new disk is created. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool + # - projects/project/zones/zone/storagePools/storagePool + # - zones/zone/storagePools/storagePool + }, + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is + # either SCSI or NVME. For most machine types, the + # default is SCSI. Local SSDs can use either NVME or SCSI. + # In certain configurations, persistent disks can use NVMe. For more + # information, seeAbout + # persistent disks. + "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. + "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses. + "A String", + ], + "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked + # disk is not allowed to be detached from the instance, or to be used as the + # source of the snapshot creation, and the image creation. The instance with + # at least one locked attached disk is not allow to be used as source of + # machine image creation, instant snapshot creation, and not allowed to be + # deleted with --keep-disk parameter set to true for locked disks. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk + # in READ_WRITE mode. + "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this + # field is set to PRESERVED if the LocalSSD data has been saved + # to a persistent location by customer request. (see the + # discard_local_ssd option on Stop/Suspend). + # Read-only in the api. + "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk + # these are public keys which are safe to store in public + "dbs": [ # The Key Database (db). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "dbxs": [ # The forbidden key database (dbx). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "keks": [ # The Key Exchange Key (KEK). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "pk": { # The Platform Key (PK). + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + }, + "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk + # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # If desired, you can also attach existing non-root persistent disks using + # this property. This field is only applicable for persistent disks. + # + # Note that for InstanceTemplate, specify the disk name for zonal disk, + # and the URL for regional disk. + "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. + "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of + # URLs to the license resource. Unlike regular licenses, user provided + # licenses can be modified after the disk is created. + "A String", + ], + }, + ], + "machineTypes": [ # Alternative machine types to use for instances that are created from + # these properties. This field only accepts a machine type names, for + # example `n2-standard-4` and not URLs or partial URLs. + "A String", + ], + "rank": "A String", # Rank when prioritizing the shape flexibilities. + # The instance selections with rank are considered + # first, in the ascending order of the rank. + # If not set, defaults to 0. + }, + }, + }, "instanceProperties": { # The instance properties defining the VM instances to be created. Required # if sourceInstanceTemplate is not provided. "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features. diff --git a/docs/dyn/compute_beta.interconnectAttachments.html b/docs/dyn/compute_beta.interconnectAttachments.html index c69f755d87..63535c27b6 100644 --- a/docs/dyn/compute_beta.interconnectAttachments.html +++ b/docs/dyn/compute_beta.interconnectAttachments.html @@ -251,6 +251,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1011,6 +1012,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1400,6 +1402,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2154,6 +2157,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2595,6 +2599,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 9bf6908202..e6bc28349a 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -96,6 +96,518 @@

Method Details

# compute.regionInstances.bulkInsert . This resource is not persisted # anywhere, it is used only for processing the requests. "count": "A String", # The maximum number of instances to create. + "instanceFlexibilityPolicy": { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create. + "instanceSelections": { # Specification of alternative, flexible instance subsets. + # One of them will be selected to create the instances + # based on various criteria, like: + # - ranks, + # - location policy, + # - current capacity, + # - available reservations (you can specify affinity in + # InstanceProperties), + # - SWAN/GOOSE limitations. + # Key is an arbitrary, unique RFC1035 string that identifies the instance + # selection. + "a_key": { # Specification of machine type to use. Every position inside this message + # is an alternative. + # The count specified in the shape flexibility must not exceed the number + # of entries in per_instance_properties or the capacity of the + # name_pattern, if used. + "disks": [ # Disks to be attached to the instances created from in this selection. + # They override the disks specified in the instance properties. + { # An instance-attached disk resource. + "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 + # or X86_64. + "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is + # deleted (but not when the disk is detached from the instance). + "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first + # partition of the disk for its root filesystem. + "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system + # running within the instance. This name can be used to reference the device + # for mounting, resizing, and so on, from within the instance. + # + # If not specified, the server chooses a default device name to apply to this + # disk, in the form persistent-disk-x, where x is a number + # assigned by Google Compute Engine. This field is only applicable for + # persistent disks. + "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied + # encryption key. + # + # If you are creating a new disk, this field encrypts the new disk using + # an encryption key that you provide. If you are attaching an existing + # disk that is already encrypted, this field decrypts the disk using + # the customer-supplied encryption key. + # + # If you encrypt a disk using a customer-supplied key, you must provide the + # same key again when you attempt to use this resource at a later time. For + # example, you must provide the key when you create a snapshot or an image + # from the disk or when you attach the disk to a virtual machine instance. + # + # If you do not provide an encryption key, then the disk will be encrypted + # using an automatically generated key and you do not need to provide a key + # to use the disk later. + # + # Note: + # + # Instance templates do not storecustomer-supplied + # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group. + # + # You cannot create VMs that have disks with customer-supplied keys using + # the bulk + # insert method. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "diskSizeGb": "A String", # The size of the disk in GB. + "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's + # currently attached to another instance. If you try to force attach a zonal + # disk to an instance, you will receive an error. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the + # boot disk. If you have many disks attached to an instance, each + # disk would have a unique index number. + "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This field is persisted and returned for instanceTemplate and not returned + # in the context of instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + "architecture": "A String", # The architecture of the attached disk. Valid values are + # arm64 or x86_64. + "description": "A String", # An optional description. Provide this property when creating the disk. + "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name + # of the instance. If a disk with the same name already exists in the given + # region, the existing disk is attached to the new instance and the + # new disk is not created. + "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least + # 10 GB. If you specify a sourceImage, which is required for + # boot disks, the default size is the size of the sourceImage. + # If you do not specify a sourceImage, the default disk size + # is 500 GB. + "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, + # the default is pd-standard, specified using the full URL. + # For example: + # + # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard + # + # + # For a full list of acceptable values, seePersistent disk + # types. If you specify this field when creating a VM, you can provide + # either the full or partial URL. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # If you specify this field when creating or updating an instance template + # or all-instances configuration, specify the type of the disk, not the + # URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + # + # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for + # persistent disks. + "a_key": "A String", + }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], + "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to + # more than one instance. + "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default + # is to use the existing disk. + "provisionedIops": "A String", # 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 10,000 and 120,000. For more details, see theExtreme persistent + # disk documentation. + "provisionedThroughput": "A String", # 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 + # greater than or equal to 1. + "replicaZones": [ # Required for each regional disk associated with the instance. Specify + # the URLs of the zones where the disk should be replicated to. + # You must provide exactly two replica zones, and one zone must be the same + # as the instance zone. + "A String", + ], + "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + # have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced + # format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when + # empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. + # Specified using the full or partial URL. For instance template, specify + # only the resource policy name. + "A String", + ], + "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot + # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # To create a disk with one of the public operating system + # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: + # + # projects/debian-cloud/global/images/family/debian-9 + # + # + # Alternatively, use a specific version of a public operating system image: + # + # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + # + # + # To create a disk with a custom image that you created, specify the + # image name in the following format: + # + # global/images/my-custom-image + # + # + # You can also specify a custom image by its image family, which returns + # the latest version of the image in that family. Replace the image name + # with family/family-name: + # + # global/images/family/my-image-family + # + # + # If the source image is deleted later, this field will not be set. + "sourceImageEncryptionKey": { # Thecustomer-supplied + # encryption key of the source image. Required if the source image is + # protected by a customer-supplied encryption key. + # + # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied + # encryption keys, so you cannot create disks for instances in a managed instance group if the + # source images are encrypted with your own keys. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new + # instance boot disk, one of initializeParams.sourceSnapshot + # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # us-central1-a/instantSnapshots/my-backup + # + # + # If the source instant-snapshot is deleted later, this field will not be + # set. + "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance + # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # global/snapshots/my-backup + # + # + # If the source snapshot is deleted later, this field will not be set. + # + # Note: You cannot create VMs in bulk using a snapshot as the source. Use + # an image instead when you create VMs using + # the bulk + # insert method. + "sourceSnapshotEncryptionKey": { # Thecustomer-supplied + # encryption key of the source snapshot. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "storagePool": "A String", # The storage pool in which the new disk is created. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool + # - projects/project/zones/zone/storagePools/storagePool + # - zones/zone/storagePools/storagePool + }, + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is + # either SCSI or NVME. For most machine types, the + # default is SCSI. Local SSDs can use either NVME or SCSI. + # In certain configurations, persistent disks can use NVMe. For more + # information, seeAbout + # persistent disks. + "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. + "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses. + "A String", + ], + "locked": True or False, # Output only. [Output Only] Whether to indicate the attached disk is locked. The locked + # disk is not allowed to be detached from the instance, or to be used as the + # source of the snapshot creation, and the image creation. The instance with + # at least one locked attached disk is not allow to be used as source of + # machine image creation, instant snapshot creation, and not allowed to be + # deleted with --keep-disk parameter set to true for locked disks. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk + # in READ_WRITE mode. + "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this + # field is set to PRESERVED if the LocalSSD data has been saved + # to a persistent location by customer request. (see the + # discard_local_ssd option on Stop/Suspend). + # Read-only in the api. + "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk + # these are public keys which are safe to store in public + "dbs": [ # The Key Database (db). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "dbxs": [ # The forbidden key database (dbx). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "keks": [ # The Key Exchange Key (KEK). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "pk": { # The Platform Key (PK). + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + }, + "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk + # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # If desired, you can also attach existing non-root persistent disks using + # this property. This field is only applicable for persistent disks. + # + # Note that for InstanceTemplate, specify the disk name for zonal disk, + # and the URL for regional disk. + "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. + "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of + # URLs to the license resource. Unlike regular licenses, user provided + # licenses can be modified after the disk is created. + "A String", + ], + }, + ], + "machineTypes": [ # Alternative machine types to use for instances that are created from + # these properties. This field only accepts a machine type names, for + # example `n2-standard-4` and not URLs or partial URLs. + "A String", + ], + "rank": "A String", # Rank when prioritizing the shape flexibilities. + # The instance selections with rank are considered + # first, in the ascending order of the rank. + # If not set, defaults to 0. + }, + }, + }, "instanceProperties": { # The instance properties defining the VM instances to be created. Required # if sourceInstanceTemplate is not provided. "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features. diff --git a/docs/dyn/compute_beta.reservationSlots.html b/docs/dyn/compute_beta.reservationSlots.html new file mode 100644 index 0000000000..45016e3404 --- /dev/null +++ b/docs/dyn/compute_beta.reservationSlots.html @@ -0,0 +1,696 @@ + + + +

Compute Engine API . reservationSlots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, zone, parentName, reservationSlot, x__xgafv=None)

+

Retrieves information about the specified reservation slot.

+

+ list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of reservation slots under a single reservation.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)

+

Update a reservation slot in the specified sub-block.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, zone, parentName, reservationSlot, x__xgafv=None) +
Retrieves information about the specified reservation slot.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  reservationSlot: string, The name of the reservation slot, formatted as RFC1035 or a resource ID
+number. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "resource": { # Represents a reservation slot resource.
+    "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+    "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+        # defined by the server.
+    "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+    "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+    "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+      "block": "A String", # The unique identifier of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation sub-block.
+      "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+      "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+          # block.
+    },
+    "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+    "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+    "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+        # to inherit the share settings from a parent resource.
+      "projectMap": { # A map of project id and project config. This is only valid when
+          # share_type's value is SPECIFIC_PROJECTS.
+        "a_key": { # Config for each project in the share settings.
+          "projectId": "A String", # The project ID, should be same as the key of this project config in the
+              # parent map.
+        },
+      },
+      "projects": [ # A List of Project names to specify consumer projects for this
+          # shared-reservation. This is only valid when share_type's value is
+          # SPECIFIC_PROJECTS.
+        "A String",
+      ],
+      "shareType": "A String", # Type of sharing for this shared-reservation
+    },
+    "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+    "status": { # Output only. [Output Only] The status of the reservation slot.
+      "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+        "block": "A String", # The unique identifier of the capacity block within the cluster.
+        "cluster": "A String", # The cluster name of the reservation sub-block.
+        "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+        "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+            # block.
+      },
+      "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+        "A String",
+      ],
+      "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+        "A String",
+      ],
+    },
+    "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+  },
+}
+
+ +
+ list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of reservation slots under a single reservation.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of reservation slots within a single reservation.
+  "id": "A String", # The unique identifier for the resource; defined by the server.
+  "items": [ # A list of reservation slot resources.
+    { # Represents a reservation slot resource.
+      "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+      "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+          # defined by the server.
+      "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+      "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+      "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+        "block": "A String", # The unique identifier of the capacity block within the cluster.
+        "cluster": "A String", # The cluster name of the reservation sub-block.
+        "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+        "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+            # block.
+      },
+      "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+      "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+          # to inherit the share settings from a parent resource.
+        "projectMap": { # A map of project id and project config. This is only valid when
+            # share_type's value is SPECIFIC_PROJECTS.
+          "a_key": { # Config for each project in the share settings.
+            "projectId": "A String", # The project ID, should be same as the key of this project config in the
+                # parent map.
+          },
+        },
+        "projects": [ # A List of Project names to specify consumer projects for this
+            # shared-reservation. This is only valid when share_type's value is
+            # SPECIFIC_PROJECTS.
+          "A String",
+        ],
+        "shareType": "A String", # Type of sharing for this shared-reservation
+      },
+      "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+      "status": { # Output only. [Output Only] The status of the reservation slot.
+        "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+          "block": "A String", # The unique identifier of the capacity block within the cluster.
+          "cluster": "A String", # The cluster name of the reservation sub-block.
+          "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+          "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+              # block.
+        },
+        "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+          "A String",
+        ],
+        "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+          "A String",
+        ],
+      },
+      "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+    },
+  ],
+  "kind": "compute#reservationSlot", # The type of resource. Alwayscompute#reservationSlot for a list of reservation
+      # slots.
+  "nextPageToken": "A String", # This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # The server-defined URL for this resource.
+  "warning": { # An informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None) +
Update a reservation slot in the specified sub-block.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the sub-block resource. (required)
+  reservationSlot: string, The name of the slot resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a reservation slot resource.
+  "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+  "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+      # defined by the server.
+  "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+  "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+  "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+    "block": "A String", # The unique identifier of the capacity block within the cluster.
+    "cluster": "A String", # The cluster name of the reservation sub-block.
+    "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+    "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+        # block.
+  },
+  "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+  "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+      # to inherit the share settings from a parent resource.
+    "projectMap": { # A map of project id and project config. This is only valid when
+        # share_type's value is SPECIFIC_PROJECTS.
+      "a_key": { # Config for each project in the share settings.
+        "projectId": "A String", # The project ID, should be same as the key of this project config in the
+            # parent map.
+      },
+    },
+    "projects": [ # A List of Project names to specify consumer projects for this
+        # shared-reservation. This is only valid when share_type's value is
+        # SPECIFIC_PROJECTS.
+      "A String",
+    ],
+    "shareType": "A String", # Type of sharing for this shared-reservation
+  },
+  "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+  "status": { # Output only. [Output Only] The status of the reservation slot.
+    "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+      "block": "A String", # The unique identifier of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation sub-block.
+      "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+      "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+          # block.
+    },
+    "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+      "A String",
+    ],
+    "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+      "A String",
+    ],
+  },
+  "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+}
+
+  updateMask: string, The fields to be updated as part of this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index bf37735b69..b8b65e607f 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -489,6 +489,11 @@

Instance Methods

Returns the reservationBlocks Resource.

+

+ reservationSlots() +

+

Returns the reservationSlots Resource.

+

reservationSubBlocks()

diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 060712964d..d8f7d589e5 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -3377,6 +3377,464 @@

Method Details

# compute.regionInstances.bulkInsert . This resource is not persisted # anywhere, it is used only for processing the requests. "count": "A String", # The maximum number of instances to create. + "instanceFlexibilityPolicy": { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create. + "instanceSelections": { # Specification of alternative, flexible instance subsets. + # One of them will be selected to create the instances + # based on various criteria, like: + # - ranks, + # - location policy, + # - current capacity, + # - available reservations (you can specify affinity in + # InstanceProperties), + # - SWAN/GOOSE limitations. + # Key is an arbitrary, unique RFC1035 string that identifies the instance + # selection. + "a_key": { # Specification of machine type to use. Every position inside this message + # is an alternative. + # The count specified in the shape flexibility must not exceed the number + # of entries in per_instance_properties or the capacity of the + # name_pattern, if used. + "disks": [ # Disks to be attached to the instances created from in this selection. + # They override the disks specified in the instance properties. + { # An instance-attached disk resource. + "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 + # or X86_64. + "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is + # deleted (but not when the disk is detached from the instance). + "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first + # partition of the disk for its root filesystem. + "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system + # running within the instance. This name can be used to reference the device + # for mounting, resizing, and so on, from within the instance. + # + # If not specified, the server chooses a default device name to apply to this + # disk, in the form persistent-disk-x, where x is a number + # assigned by Google Compute Engine. This field is only applicable for + # persistent disks. + "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied + # encryption key. + # + # If you are creating a new disk, this field encrypts the new disk using + # an encryption key that you provide. If you are attaching an existing + # disk that is already encrypted, this field decrypts the disk using + # the customer-supplied encryption key. + # + # If you encrypt a disk using a customer-supplied key, you must provide the + # same key again when you attempt to use this resource at a later time. For + # example, you must provide the key when you create a snapshot or an image + # from the disk or when you attach the disk to a virtual machine instance. + # + # If you do not provide an encryption key, then the disk will be encrypted + # using an automatically generated key and you do not need to provide a key + # to use the disk later. + # + # Note: + # + # Instance templates do not storecustomer-supplied + # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group. + # + # You cannot create VMs that have disks with customer-supplied keys using + # the bulk + # insert method. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "diskSizeGb": "A String", # The size of the disk in GB. + "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's + # currently attached to another instance. If you try to force attach a zonal + # disk to an instance, you will receive an error. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the + # boot disk. If you have many disks attached to an instance, each + # disk would have a unique index number. + "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This field is persisted and returned for instanceTemplate and not returned + # in the context of instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + "architecture": "A String", # The architecture of the attached disk. Valid values are + # arm64 or x86_64. + "description": "A String", # An optional description. Provide this property when creating the disk. + "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name + # of the instance. If a disk with the same name already exists in the given + # region, the existing disk is attached to the new instance and the + # new disk is not created. + "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least + # 10 GB. If you specify a sourceImage, which is required for + # boot disks, the default size is the size of the sourceImage. + # If you do not specify a sourceImage, the default disk size + # is 500 GB. + "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, + # the default is pd-standard, specified using the full URL. + # For example: + # + # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard + # + # + # For a full list of acceptable values, seePersistent disk + # types. If you specify this field when creating a VM, you can provide + # either the full or partial URL. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # If you specify this field when creating or updating an instance template + # or all-instances configuration, specify the type of the disk, not the + # URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. + "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for + # persistent disks. + "a_key": "A String", + }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], + "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default + # is to use the existing disk. + "provisionedIops": "A String", # 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 10,000 and 120,000. For more details, see theExtreme persistent + # disk documentation. + "provisionedThroughput": "A String", # 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 + # greater than or equal to 1. + "replicaZones": [ # Required for each regional disk associated with the instance. Specify + # the URLs of the zones where the disk should be replicated to. + # You must provide exactly two replica zones, and one zone must be the same + # as the instance zone. + "A String", + ], + "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + # have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced + # format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when + # empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. + # Specified using the full or partial URL. For instance template, specify + # only the resource policy name. + "A String", + ], + "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot + # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # To create a disk with one of the public operating system + # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: + # + # projects/debian-cloud/global/images/family/debian-9 + # + # + # Alternatively, use a specific version of a public operating system image: + # + # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + # + # + # To create a disk with a custom image that you created, specify the + # image name in the following format: + # + # global/images/my-custom-image + # + # + # You can also specify a custom image by its image family, which returns + # the latest version of the image in that family. Replace the image name + # with family/family-name: + # + # global/images/family/my-image-family + # + # + # If the source image is deleted later, this field will not be set. + "sourceImageEncryptionKey": { # Thecustomer-supplied + # encryption key of the source image. Required if the source image is + # protected by a customer-supplied encryption key. + # + # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied + # encryption keys, so you cannot create disks for instances in a managed instance group if the + # source images are encrypted with your own keys. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance + # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # global/snapshots/my-backup + # + # + # If the source snapshot is deleted later, this field will not be set. + # + # Note: You cannot create VMs in bulk using a snapshot as the source. Use + # an image instead when you create VMs using + # the bulk + # insert method. + "sourceSnapshotEncryptionKey": { # Thecustomer-supplied + # encryption key of the source snapshot. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "storagePool": "A String", # The storage pool in which the new disk is created. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool + # - projects/project/zones/zone/storagePools/storagePool + # - zones/zone/storagePools/storagePool + }, + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is + # either SCSI or NVME. For most machine types, the + # default is SCSI. Local SSDs can use either NVME or SCSI. + # In certain configurations, persistent disks can use NVMe. For more + # information, seeAbout + # persistent disks. + "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. + "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses. + "A String", + ], + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk + # in READ_WRITE mode. + "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this + # field is set to PRESERVED if the LocalSSD data has been saved + # to a persistent location by customer request. (see the + # discard_local_ssd option on Stop/Suspend). + # Read-only in the api. + "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk + # these are public keys which are safe to store in public + "dbs": [ # The Key Database (db). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "dbxs": [ # The forbidden key database (dbx). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "keks": [ # The Key Exchange Key (KEK). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "pk": { # The Platform Key (PK). + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + }, + "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk + # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # If desired, you can also attach existing non-root persistent disks using + # this property. This field is only applicable for persistent disks. + # + # Note that for InstanceTemplate, specify the disk name for zonal disk, + # and the URL for regional disk. + "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. + }, + ], + "machineTypes": [ # Alternative machine types to use for instances that are created from + # these properties. This field only accepts a machine type names, for + # example `n2-standard-4` and not URLs or partial URLs. + "A String", + ], + "rank": "A String", # Rank when prioritizing the shape flexibilities. + # The instance selections with rank are considered + # first, in the ascending order of the rank. + # If not set, defaults to 0. + }, + }, + }, "instanceProperties": { # The instance properties defining the VM instances to be created. Required # if sourceInstanceTemplate is not provided. "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features. diff --git a/docs/dyn/compute_v1.interconnectAttachments.html b/docs/dyn/compute_v1.interconnectAttachments.html index a524b86b45..5af4bdabc8 100644 --- a/docs/dyn/compute_v1.interconnectAttachments.html +++ b/docs/dyn/compute_v1.interconnectAttachments.html @@ -248,6 +248,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1008,6 +1009,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -1397,6 +1399,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2151,6 +2154,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # @@ -2592,6 +2596,7 @@

Method Details

# - BPS_20G: 20 Gbit/s # - BPS_50G: 50 Gbit/s # - BPS_100G: 100 Gbit/s + # - BPS_400G: 400 Gbit/s "candidateCloudRouterIpAddress": "A String", # Single IPv4 address + prefix length to be configured on the cloud router # interface for this interconnect attachment. # diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 4ae9b3353a..340e096b1c 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -96,6 +96,464 @@

Method Details

# compute.regionInstances.bulkInsert . This resource is not persisted # anywhere, it is used only for processing the requests. "count": "A String", # The maximum number of instances to create. + "instanceFlexibilityPolicy": { # A flexible specification of machine types for instances to create. # A flexible specification of machine type of instances to create. + "instanceSelections": { # Specification of alternative, flexible instance subsets. + # One of them will be selected to create the instances + # based on various criteria, like: + # - ranks, + # - location policy, + # - current capacity, + # - available reservations (you can specify affinity in + # InstanceProperties), + # - SWAN/GOOSE limitations. + # Key is an arbitrary, unique RFC1035 string that identifies the instance + # selection. + "a_key": { # Specification of machine type to use. Every position inside this message + # is an alternative. + # The count specified in the shape flexibility must not exceed the number + # of entries in per_instance_properties or the capacity of the + # name_pattern, if used. + "disks": [ # Disks to be attached to the instances created from in this selection. + # They override the disks specified in the instance properties. + { # An instance-attached disk resource. + "architecture": "A String", # Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64 + # or X86_64. + "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is + # deleted (but not when the disk is detached from the instance). + "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first + # partition of the disk for its root filesystem. + "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system + # running within the instance. This name can be used to reference the device + # for mounting, resizing, and so on, from within the instance. + # + # If not specified, the server chooses a default device name to apply to this + # disk, in the form persistent-disk-x, where x is a number + # assigned by Google Compute Engine. This field is only applicable for + # persistent disks. + "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied + # encryption key. + # + # If you are creating a new disk, this field encrypts the new disk using + # an encryption key that you provide. If you are attaching an existing + # disk that is already encrypted, this field decrypts the disk using + # the customer-supplied encryption key. + # + # If you encrypt a disk using a customer-supplied key, you must provide the + # same key again when you attempt to use this resource at a later time. For + # example, you must provide the key when you create a snapshot or an image + # from the disk or when you attach the disk to a virtual machine instance. + # + # If you do not provide an encryption key, then the disk will be encrypted + # using an automatically generated key and you do not need to provide a key + # to use the disk later. + # + # Note: + # + # Instance templates do not storecustomer-supplied + # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group. + # + # You cannot create VMs that have disks with customer-supplied keys using + # the bulk + # insert method. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "diskSizeGb": "A String", # The size of the disk in GB. + "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's + # currently attached to another instance. If you try to force attach a zonal + # disk to an instance, you will receive an error. + "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable + # only for bootable images. Read + # Enabling guest operating system features to see a list of available + # options. + { # Guest OS features. + "type": "A String", # The ID of a supported feature. To add multiple values, use commas to + # separate values. Set to one or more of the following values: + # + # - VIRTIO_SCSI_MULTIQUEUE + # - WINDOWS + # - MULTI_IP_SUBNET + # - UEFI_COMPATIBLE + # - GVNIC + # - SEV_CAPABLE + # - SUSPEND_RESUME_COMPATIBLE + # - SEV_LIVE_MIGRATABLE_V2 + # - SEV_SNP_CAPABLE + # - TDX_CAPABLE + # - IDPF + # - SNP_SVSM_CAPABLE + # + # + # For more information, see + # Enabling guest operating system features. + }, + ], + "index": 42, # Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the + # boot disk. If you have many disks attached to an instance, each + # disk would have a unique index number. + "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + # alongside the new instance. Use initialization parameters to create boot + # disks or local SSDs attached to the new instance. + # + # This field is persisted and returned for instanceTemplate and not returned + # in the context of instance. + # + # This property is mutually exclusive with the source property; + # you can only define one or the other, but not both. + "architecture": "A String", # The architecture of the attached disk. Valid values are + # arm64 or x86_64. + "description": "A String", # An optional description. Provide this property when creating the disk. + "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name + # of the instance. If a disk with the same name already exists in the given + # region, the existing disk is attached to the new instance and the + # new disk is not created. + "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least + # 10 GB. If you specify a sourceImage, which is required for + # boot disks, the default size is the size of the sourceImage. + # If you do not specify a sourceImage, the default disk size + # is 500 GB. + "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, + # the default is pd-standard, specified using the full URL. + # For example: + # + # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard + # + # + # For a full list of acceptable values, seePersistent disk + # types. If you specify this field when creating a VM, you can provide + # either the full or partial URL. For example, the following values are + # valid: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType + # - projects/project/zones/zone/diskTypes/diskType + # - zones/zone/diskTypes/diskType + # + # + # If you specify this field when creating or updating an instance template + # or all-instances configuration, specify the type of the disk, not the + # URL. For example: pd-standard. + "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode. + "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for + # persistent disks. + "a_key": "A String", + }, + "licenses": [ # A list of publicly visible licenses. Reserved for Google's use. + "A String", + ], + "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default + # is to use the existing disk. + "provisionedIops": "A String", # 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 10,000 and 120,000. For more details, see theExtreme persistent + # disk documentation. + "provisionedThroughput": "A String", # 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 + # greater than or equal to 1. + "replicaZones": [ # Required for each regional disk associated with the instance. Specify + # the URLs of the zones where the disk should be replicated to. + # You must provide exactly two replica zones, and one zone must be the same + # as the instance zone. + "A String", + ], + "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + # have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced + # format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when + # empty. + "a_key": "A String", + }, + "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. + # Specified using the full or partial URL. For instance template, specify + # only the resource policy name. + "A String", + ], + "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot + # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # To create a disk with one of the public operating system + # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image: + # + # projects/debian-cloud/global/images/family/debian-9 + # + # + # Alternatively, use a specific version of a public operating system image: + # + # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD + # + # + # To create a disk with a custom image that you created, specify the + # image name in the following format: + # + # global/images/my-custom-image + # + # + # You can also specify a custom image by its image family, which returns + # the latest version of the image in that family. Replace the image name + # with family/family-name: + # + # global/images/family/my-image-family + # + # + # If the source image is deleted later, this field will not be set. + "sourceImageEncryptionKey": { # Thecustomer-supplied + # encryption key of the source image. Required if the source image is + # protected by a customer-supplied encryption key. + # + # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied + # encryption keys, so you cannot create disks for instances in a managed instance group if the + # source images are encrypted with your own keys. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance + # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source + # is required. + # + # To create a disk with a snapshot that you created, specify the + # snapshot name in the following format: + # + # global/snapshots/my-backup + # + # + # If the source snapshot is deleted later, this field will not be set. + # + # Note: You cannot create VMs in bulk using a snapshot as the source. Use + # an image instead when you create VMs using + # the bulk + # insert method. + "sourceSnapshotEncryptionKey": { # Thecustomer-supplied + # encryption key of the source snapshot. + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. + # For example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # + # The fully-qualifed key name may be returned for resource GET requests. For + # example: + # + # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ + # key_region/cryptoKeys/key + # /cryptoKeyVersions/1 + "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # For example: + # + # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/ + "rawKey": "A String", # Specifies a 256-bit customer-supplied + # encryption key, encoded in RFC + # 4648 base64 to either encrypt or decrypt this resource. You can + # provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rawKey": + # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" + "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit + # customer-supplied encryption key to either encrypt or decrypt this + # resource. You can provide either the rawKey or thersaEncryptedKey. + # For example: + # + # "rsaEncryptedKey": + # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH + # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD + # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" + # + # The key must meet the following requirements before you can provide it to + # Compute Engine: + # + # 1. The key is wrapped using a RSA public key certificate provided by + # Google. + # 2. After being wrapped, the key must be encoded in RFC 4648 base64 + # encoding. + # + # Gets the RSA public key certificate provided by Google at: + # + # + # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem + "sha256": "A String", # [Output only] TheRFC + # 4648 base64 encoded SHA-256 hash of the customer-supplied + # encryption key that protects this resource. + }, + "storagePool": "A String", # The storage pool in which the new disk is created. You can provide + # this as a partial or full URL to the resource. For example, the following + # are valid values: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool + # - projects/project/zones/zone/storagePools/storagePool + # - zones/zone/storagePools/storagePool + }, + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is + # either SCSI or NVME. For most machine types, the + # default is SCSI. Local SSDs can use either NVME or SCSI. + # In certain configurations, persistent disks can use NVMe. For more + # information, seeAbout + # persistent disks. + "kind": "compute#attachedDisk", # Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks. + "licenses": [ # Output only. [Output Only] Any valid publicly visible licenses. + "A String", + ], + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk + # in READ_WRITE mode. + "savedState": "A String", # Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this + # field is set to PRESERVED if the LocalSSD data has been saved + # to a persistent location by customer request. (see the + # discard_local_ssd option on Stop/Suspend). + # Read-only in the api. + "shieldedInstanceInitialState": { # Initial State for shielded instance, # Output only. [Output Only] shielded vm initial state stored on disk + # these are public keys which are safe to store in public + "dbs": [ # The Key Database (db). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "dbxs": [ # The forbidden key database (dbx). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "keks": [ # The Key Exchange Key (KEK). + { + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + ], + "pk": { # The Platform Key (PK). + "content": "A String", # The raw content in the secure keys file. + "fileType": "A String", # The file type of source file. + }, + }, + "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk + # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source + # is required. + # + # If desired, you can also attach existing non-root persistent disks using + # this property. This field is only applicable for persistent disks. + # + # Note that for InstanceTemplate, specify the disk name for zonal disk, + # and the URL for regional disk. + "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. + }, + ], + "machineTypes": [ # Alternative machine types to use for instances that are created from + # these properties. This field only accepts a machine type names, for + # example `n2-standard-4` and not URLs or partial URLs. + "A String", + ], + "rank": "A String", # Rank when prioritizing the shape flexibilities. + # The instance selections with rank are considered + # first, in the ascending order of the rank. + # If not set, defaults to 0. + }, + }, + }, "instanceProperties": { # The instance properties defining the VM instances to be created. Required # if sourceInstanceTemplate is not provided. "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Controls for advanced machine-related behavior features. diff --git a/docs/dyn/compute_v1.reservationSlots.html b/docs/dyn/compute_v1.reservationSlots.html new file mode 100644 index 0000000000..8304aa8dfc --- /dev/null +++ b/docs/dyn/compute_v1.reservationSlots.html @@ -0,0 +1,681 @@ + + + +

Compute Engine API . reservationSlots

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, zone, parentName, reservationSlot, x__xgafv=None)

+

Retrieves information about the specified reservation slot.

+

+ list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of reservation slots under a single reservation.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None)

+

Update a reservation slot in the specified sub-block.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, zone, parentName, reservationSlot, x__xgafv=None) +
Retrieves information about the specified reservation slot.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  reservationSlot: string, The name of the reservation slot, formatted as RFC1035 or a resource ID
+number. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "resource": { # Represents a reservation slot resource.
+    "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+    "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+        # defined by the server.
+    "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+    "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+    "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+      "block": "A String", # The unique identifier of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation sub-block.
+      "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+      "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+          # block.
+    },
+    "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+    "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+    "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+        # to inherit the share settings from a parent resource.
+      "projectMap": { # A map of project id and project config. This is only valid when
+          # share_type's value is SPECIFIC_PROJECTS.
+        "a_key": { # Config for each project in the share settings.
+          "projectId": "A String", # The project ID, should be same as the key of this project config in the
+              # parent map.
+        },
+      },
+      "shareType": "A String", # Type of sharing for this shared-reservation
+    },
+    "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+    "status": { # Output only. [Output Only] The status of the reservation slot.
+      "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+        "block": "A String", # The unique identifier of the capacity block within the cluster.
+        "cluster": "A String", # The cluster name of the reservation sub-block.
+        "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+        "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+            # block.
+      },
+      "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+        "A String",
+      ],
+      "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+        "A String",
+      ],
+    },
+    "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+  },
+}
+
+ +
+ list(project, zone, parentName, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves a list of reservation slots under a single reservation.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block, formatted as
+reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name} (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A list of reservation slots within a single reservation.
+  "id": "A String", # The unique identifier for the resource; defined by the server.
+  "items": [ # A list of reservation slot resources.
+    { # Represents a reservation slot resource.
+      "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+      "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+          # defined by the server.
+      "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+      "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+      "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+        "block": "A String", # The unique identifier of the capacity block within the cluster.
+        "cluster": "A String", # The cluster name of the reservation sub-block.
+        "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+        "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+            # block.
+      },
+      "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+      "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+          # to inherit the share settings from a parent resource.
+        "projectMap": { # A map of project id and project config. This is only valid when
+            # share_type's value is SPECIFIC_PROJECTS.
+          "a_key": { # Config for each project in the share settings.
+            "projectId": "A String", # The project ID, should be same as the key of this project config in the
+                # parent map.
+          },
+        },
+        "shareType": "A String", # Type of sharing for this shared-reservation
+      },
+      "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+      "status": { # Output only. [Output Only] The status of the reservation slot.
+        "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+          "block": "A String", # The unique identifier of the capacity block within the cluster.
+          "cluster": "A String", # The cluster name of the reservation sub-block.
+          "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+          "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+              # block.
+        },
+        "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+          "A String",
+        ],
+        "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+          "A String",
+        ],
+      },
+      "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+    },
+  ],
+  "kind": "compute#reservationSlot", # The type of resource. Alwayscompute#reservationSlot for a list of reservation
+      # slots.
+  "nextPageToken": "A String", # This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # The server-defined URL for this resource.
+  "warning": { # An informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ update(project, zone, parentName, reservationSlot, body=None, updateMask=None, x__xgafv=None) +
Update a reservation slot in the specified sub-block.
+
+Args:
+  project: string, The project ID for this request. (required)
+  zone: string, The name of the zone for this request, formatted as RFC1035. (required)
+  parentName: string, The name of the sub-block resource. (required)
+  reservationSlot: string, The name of the slot resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a reservation slot resource.
+  "creationTimestamp": "A String", # Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.
+  "id": "A String", # Output only. [Output Only] The unique identifier for this resource. This identifier is
+      # defined by the server.
+  "kind": "compute#reservationSlot", # Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.
+  "name": "A String", # Output only. [Output Only] The name of the reservation slot.
+  "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation slot.
+    "block": "A String", # The unique identifier of the capacity block within the cluster.
+    "cluster": "A String", # The cluster name of the reservation sub-block.
+    "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+    "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+        # block.
+  },
+  "selfLink": "A String", # Output only. [Output Only] A server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] A server-defined URL for this resource with the resource ID.
+  "shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share settings to create a shared slot. Set to empty
+      # to inherit the share settings from a parent resource.
+    "projectMap": { # A map of project id and project config. This is only valid when
+        # share_type's value is SPECIFIC_PROJECTS.
+      "a_key": { # Config for each project in the share settings.
+        "projectId": "A String", # The project ID, should be same as the key of this project config in the
+            # parent map.
+      },
+    },
+    "shareType": "A String", # Type of sharing for this shared-reservation
+  },
+  "state": "A String", # Output only. [Output Only] The state of the reservation slot.
+  "status": { # Output only. [Output Only] The status of the reservation slot.
+    "physicalTopology": { # Output only. [Output Only] The physical topology of the reservation sub-block.
+      "block": "A String", # The unique identifier of the capacity block within the cluster.
+      "cluster": "A String", # The cluster name of the reservation sub-block.
+      "host": "A String", # The unique identifier of the capacity host within the capacity sub-block.
+      "subBlock": "A String", # The unique identifier of the capacity sub-block within the capacity
+          # block.
+    },
+    "rdmaIpAddresses": [ # Output only. The RDMA IP address of the physical host.
+      "A String",
+    ],
+    "runningInstances": [ # Output only. The URIs of the instances currently running on this slot.
+      "A String",
+    ],
+  },
+  "zone": "A String", # Output only. [Output Only] The zone in which the reservation slot resides.
+}
+
+  updateMask: string, The fields to be updated as part of this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index f090f6c5bd..51e8ab451e 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -40855,26 +40855,26 @@ ], "parameters": { "parentName": { -"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", "location": "path", "pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", "required": true, "type": "string" }, "project": { -"description": "Project ID for this request.", +"description": "The project ID for this request.", "location": "path", "required": true, "type": "string" }, "reservationSlot": { -"description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.", +"description": "The name of the reservation slot, formatted as RFC1035 or a resource ID\nnumber.", "location": "path", "required": true, "type": "string" }, "zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"description": "The name of the zone for this request, formatted as RFC1035.", "location": "path", "required": true, "type": "string" @@ -40925,14 +40925,14 @@ "type": "string" }, "parentName": { -"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", "location": "path", "pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", "required": true, "type": "string" }, "project": { -"description": "Project ID for this request.", +"description": "The project ID for this request.", "location": "path", "required": true, "type": "string" @@ -40943,7 +40943,7 @@ "type": "boolean" }, "zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"description": "The name of the zone for this request, formatted as RFC1035.", "location": "path", "required": true, "type": "string" @@ -53741,7 +53741,7 @@ } } }, -"revision": "20251230", +"revision": "20260113", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -58144,18 +58144,6 @@ false }, "readOnly": true, "type": "array" -}, -"vpcNetworkScope": { -"description": "The network scope of the backends that can be added to the backend\nservice. This field can be either GLOBAL_VPC_NETWORK orREGIONAL_VPC_NETWORK.\n\nA backend service with the VPC scope set to GLOBAL_VPC_NETWORK\nis only allowed to have backends in global VPC networks.\n\nWhen the VPC scope is set to REGIONAL_VPC_NETWORK the backend\nservice is only allowed to have backends in regional networks in the same\nscope as the backend service.\nNote: if not specified then GLOBAL_VPC_NETWORK will be used.", -"enum": [ -"GLOBAL_VPC_NETWORK", -"REGIONAL_VPC_NETWORK" -], -"enumDescriptions": [ -"The backend service can only have backends in global VPCs", -"The backend service can only have backends in regional VPCs" -], -"type": "string" } }, "type": "object" @@ -78982,7 +78970,7 @@ false "Public reportable behaviors", "", "", -"" +"Unrecoverable GPU error identified by an XID" ], "type": "string" }, @@ -80373,7 +80361,7 @@ false "type": "string" }, "bandwidth": { -"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s", +"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s\n - BPS_400G: 400 Gbit/s", "enum": [ "BPS_100G", "BPS_100M", @@ -81246,7 +81234,7 @@ false "type": "boolean" }, "bandwidth": { -"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s", +"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s\n - BPS_400G: 400 Gbit/s", "enum": [ "BPS_100G", "BPS_100M", @@ -103805,47 +103793,49 @@ false "id": "ReservationSlot", "properties": { "creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.", +"description": "Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.", "readOnly": true, "type": "string" }, -"description": { -"description": "An optional description of this resource.", -"type": "string" -}, "id": { -"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"description": "Output only. [Output Only] The unique identifier for this resource. This identifier is\ndefined by the server.", "format": "uint64", "readOnly": true, "type": "string" }, "kind": { "default": "compute#reservationSlot", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#reservationSlot for reservation slots.", +"description": "Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.", "readOnly": true, "type": "string" }, "name": { -"description": "Output only. [Output Only] The name of this reservation slot generated by\nCompute Engine. The name must be 1-63 characters long, and comply with\nRFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"description": "Output only. [Output Only] The name of the reservation slot.", "readOnly": true, "type": "string" }, +"physicalTopology": { +"$ref": "ReservationSlotPhysicalTopology", +"deprecated": true, +"description": "Output only. [Output Only] The physical topology of the reservation slot.", +"readOnly": true +}, "selfLink": { -"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.", +"description": "Output only. [Output Only] A server-defined fully-qualified URL for this resource.", "readOnly": true, "type": "string" }, "selfLinkWithId": { -"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.", +"description": "Output only. [Output Only] A server-defined URL for this resource with the resource ID.", "readOnly": true, "type": "string" }, "shareSettings": { "$ref": "ShareSettings", -"description": "Specify share-settings to create a shared slot. Set to empty\nto inherit share settings from a parent resource." +"description": "Specify share settings to create a shared slot. Set to empty\nto inherit the share settings from a parent resource." }, "state": { -"description": "Output only. [Output Only] State of the reservation slot.", +"description": "Output only. [Output Only] The state of the reservation slot.", "enum": [ "ACTIVE", "CREATING", @@ -103853,9 +103843,9 @@ false "STATE_UNSPECIFIED" ], "enumDescriptions": [ -"Reservation slot has allocated all its resources.", -"Resources are being allocated for the reservation slot.", -"Reservation slot is currently being deleted.", +"The reservation slot has allocated all its resources.", +"The resources are being allocated for the reservation slot.", +"The reservation slot is currently being deleted.", "" ], "readOnly": true, @@ -103867,7 +103857,7 @@ false "readOnly": true }, "zone": { -"description": "Output only. [Output Only] Zone in which the reservation slot resides.", +"description": "Output only. [Output Only] The zone in which the reservation slot resides.", "readOnly": true, "type": "string" } @@ -103878,19 +103868,19 @@ false "id": "ReservationSlotPhysicalTopology", "properties": { "block": { -"description": "The hash of the capacity block within the cluster.", +"description": "The unique identifier of the capacity block within the cluster.", "type": "string" }, "cluster": { -"description": "The cluster name of the reservation subBlock.", +"description": "The cluster name of the reservation sub-block.", "type": "string" }, "host": { -"description": "The hash of the capacity host within the capacity sub-block.", +"description": "The unique identifier of the capacity host within the capacity sub-block.", "type": "string" }, "subBlock": { -"description": "The hash of the capacity sub-block within the capacity block.", +"description": "The unique identifier of the capacity sub-block within the capacity\nblock.", "type": "string" } }, @@ -103901,7 +103891,7 @@ false "properties": { "physicalTopology": { "$ref": "ReservationSlotPhysicalTopology", -"description": "Output only. [Output Only] The physical topology of the reservation subBlock.", +"description": "Output only. [Output Only] The physical topology of the reservation sub-block.", "readOnly": true }, "rdmaIpAddresses": { @@ -103933,11 +103923,11 @@ false "type": "object" }, "ReservationSlotsListResponse": { -"description": "A list of reservation slots under a single reservation.", +"description": "A list of reservation slots within a single reservation.", "id": "ReservationSlotsListResponse", "properties": { "id": { -"description": "Unique identifier for the resource; defined by the server.", +"description": "The unique identifier for the resource; defined by the server.", "type": "string" }, "items": { @@ -103949,7 +103939,7 @@ false }, "kind": { "default": "compute#reservationSlot", -"description": "Type of the resource. Alwayscompute#reservationSlot for a list of reservation\nslots.", +"description": "The type of resource. Alwayscompute#reservationSlot for a list of reservation\nslots.", "type": "string" }, "nextPageToken": { @@ -103957,11 +103947,11 @@ false "type": "string" }, "selfLink": { -"description": "Server-defined URL for this resource.", +"description": "The server-defined URL for this resource.", "type": "string" }, "warning": { -"description": "Informational warning message.", +"description": "An informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 7c42e294f1..6d59fb706f 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -37818,6 +37818,183 @@ } } }, +"reservationSlots": { +"methods": { +"get": { +"description": "Retrieves information about the specified reservation slot.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}", +"httpMethod": "GET", +"id": "compute.reservationSlots.get", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationSlot": { +"description": "The name of the reservation slot, formatted as RFC1035 or a resource ID\nnumber.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}", +"response": { +"$ref": "ReservationSlotsGetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of reservation slots under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots", +"httpMethod": "GET", +"id": "compute.reservationSlots.list", +"parameterOrder": [ +"project", +"zone", +"parentName" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"parentName": { +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots", +"response": { +"$ref": "ReservationSlotsListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Update a reservation slot in the specified sub-block.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}", +"httpMethod": "POST", +"id": "compute.reservationSlots.update", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the sub-block resource.", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationSlot": { +"description": "The name of the slot resource.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}", +"request": { +"$ref": "ReservationSlot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "reservationSubBlocks": { "methods": { "get": { @@ -49580,7 +49757,7 @@ } } }, -"revision": "20251230", +"revision": "20260113", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55353,6 +55530,10 @@ false "format": "int64", "type": "string" }, +"instanceFlexibilityPolicy": { +"$ref": "InstanceFlexibilityPolicy", +"description": "A flexible specification of machine type of instances to create." +}, "instanceProperties": { "$ref": "InstanceProperties", "description": "The instance properties defining the VM instances to be created. Required\nif sourceInstanceTemplate is not provided." @@ -67503,6 +67684,46 @@ false }, "type": "object" }, +"InstanceFlexibilityPolicy": { +"description": "A flexible specification of machine types for instances to create.", +"id": "InstanceFlexibilityPolicy", +"properties": { +"instanceSelections": { +"additionalProperties": { +"$ref": "InstanceFlexibilityPolicyInstanceSelection" +}, +"description": "Specification of alternative, flexible instance subsets.\nOne of them will be selected to create the instances\nbased on various criteria, like:\n- ranks,\n- location policy,\n- current capacity,\n- available reservations (you can specify affinity in\nInstanceProperties),\n- SWAN/GOOSE limitations.\nKey is an arbitrary, unique RFC1035 string that identifies the instance\nselection.", +"type": "object" +} +}, +"type": "object" +}, +"InstanceFlexibilityPolicyInstanceSelection": { +"description": "Specification of machine type to use. Every position inside this message\nis an alternative.\nThe count specified in the shape flexibility must not exceed the number\nof entries in per_instance_properties or the capacity of the\nname_pattern, if used.", +"id": "InstanceFlexibilityPolicyInstanceSelection", +"properties": { +"disks": { +"description": "Disks to be attached to the instances created from in this selection.\nThey override the disks specified in the instance properties.", +"items": { +"$ref": "AttachedDisk" +}, +"type": "array" +}, +"machineTypes": { +"description": "Alternative machine types to use for instances that are created from\nthese properties. This field only accepts a machine type names, for\nexample `n2-standard-4` and not URLs or partial URLs.", +"items": { +"type": "string" +}, +"type": "array" +}, +"rank": { +"description": "Rank when prioritizing the shape flexibilities.\nThe instance selections with rank are considered\nfirst, in the ascending order of the rank.\nIf not set, defaults to 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "InstanceGroup": { "description": "Represents an Instance Group resource.\n\nInstance Groups can be used to configure a target forload\nbalancing.\n\nInstance groups can either be managed or unmanaged.\n\nTo create \nmanaged instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.\n\nUse zonal unmanaged instance groups if you need to applyload\nbalancing to groups of heterogeneous instances or if you need to manage\nthe instances yourself. You cannot create regional unmanaged instance groups.\n\nFor more information, readInstance\ngroups.", "id": "InstanceGroup", @@ -71849,7 +72070,7 @@ false "Public reportable behaviors", "", "", -"" +"Unrecoverable GPU error identified by an XID" ], "type": "string" }, @@ -73095,7 +73316,7 @@ false "type": "string" }, "bandwidth": { -"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s", +"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s\n - BPS_400G: 400 Gbit/s", "enum": [ "BPS_100G", "BPS_100M", @@ -92674,6 +92895,295 @@ false }, "type": "object" }, +"ReservationSlot": { +"description": "Represents a reservation slot resource.", +"id": "ReservationSlot", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for this resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#reservationSlot", +"description": "Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. [Output Only] The name of the reservation slot.", +"readOnly": true, +"type": "string" +}, +"physicalTopology": { +"$ref": "ReservationSlotPhysicalTopology", +"deprecated": true, +"description": "Output only. [Output Only] The physical topology of the reservation slot.", +"readOnly": true +}, +"selfLink": { +"description": "Output only. [Output Only] A server-defined fully-qualified URL for this resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] A server-defined URL for this resource with the resource ID.", +"readOnly": true, +"type": "string" +}, +"shareSettings": { +"$ref": "ShareSettings", +"description": "Specify share settings to create a shared slot. Set to empty\nto inherit the share settings from a parent resource." +}, +"state": { +"description": "Output only. [Output Only] The state of the reservation slot.", +"enum": [ +"ACTIVE", +"CREATING", +"DELETING", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation slot has allocated all its resources.", +"The resources are being allocated for the reservation slot.", +"The reservation slot is currently being deleted.", +"" +], +"readOnly": true, +"type": "string" +}, +"status": { +"$ref": "ReservationSlotStatus", +"description": "Output only. [Output Only] The status of the reservation slot.", +"readOnly": true +}, +"zone": { +"description": "Output only. [Output Only] The zone in which the reservation slot resides.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReservationSlotPhysicalTopology": { +"id": "ReservationSlotPhysicalTopology", +"properties": { +"block": { +"description": "The unique identifier of the capacity block within the cluster.", +"type": "string" +}, +"cluster": { +"description": "The cluster name of the reservation sub-block.", +"type": "string" +}, +"host": { +"description": "The unique identifier of the capacity host within the capacity sub-block.", +"type": "string" +}, +"subBlock": { +"description": "The unique identifier of the capacity sub-block within the capacity\nblock.", +"type": "string" +} +}, +"type": "object" +}, +"ReservationSlotStatus": { +"id": "ReservationSlotStatus", +"properties": { +"physicalTopology": { +"$ref": "ReservationSlotPhysicalTopology", +"description": "Output only. [Output Only] The physical topology of the reservation sub-block.", +"readOnly": true +}, +"rdmaIpAddresses": { +"description": "Output only. The RDMA IP address of the physical host.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"runningInstances": { +"description": "Output only. The URIs of the instances currently running on this slot.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"ReservationSlotsGetResponse": { +"id": "ReservationSlotsGetResponse", +"properties": { +"resource": { +"$ref": "ReservationSlot" +} +}, +"type": "object" +}, +"ReservationSlotsListResponse": { +"description": "A list of reservation slots within a single reservation.", +"id": "ReservationSlotsListResponse", +"properties": { +"id": { +"description": "The unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of reservation slot resources.", +"items": { +"$ref": "ReservationSlot" +}, +"type": "array" +}, +"kind": { +"default": "compute#reservationSlot", +"description": "The type of resource. Alwayscompute#reservationSlot for a list of reservation\nslots.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "The server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "An informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "ReservationSubBlock": { "description": "Represents a reservation subBlock resource.", "id": "ReservationSubBlock", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index bba9ba2c89..8609202a74 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -32175,6 +32175,183 @@ } } }, +"reservationSlots": { +"methods": { +"get": { +"description": "Retrieves information about the specified reservation slot.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}", +"httpMethod": "GET", +"id": "compute.reservationSlots.get", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationSlot": { +"description": "The name of the reservation slot, formatted as RFC1035 or a resource ID\nnumber.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}", +"response": { +"$ref": "ReservationSlotsGetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of reservation slots under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots", +"httpMethod": "GET", +"id": "compute.reservationSlots.list", +"parameterOrder": [ +"project", +"zone", +"parentName" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"parentName": { +"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots", +"response": { +"$ref": "ReservationSlotsListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Update a reservation slot in the specified sub-block.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}", +"httpMethod": "POST", +"id": "compute.reservationSlots.update", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSlot" +], +"parameters": { +"parentName": { +"description": "The name of the sub-block resource.", +"location": "path", +"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})", +"required": true, +"type": "string" +}, +"project": { +"description": "The project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationSlot": { +"description": "The name of the slot resource.", +"location": "path", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request, formatted as RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}", +"request": { +"$ref": "ReservationSlot" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "reservationSubBlocks": { "methods": { "get": { @@ -42914,7 +43091,7 @@ } } }, -"revision": "20251230", +"revision": "20260113", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48072,6 +48249,10 @@ false "format": "int64", "type": "string" }, +"instanceFlexibilityPolicy": { +"$ref": "InstanceFlexibilityPolicy", +"description": "A flexible specification of machine type of instances to create." +}, "instanceProperties": { "$ref": "InstanceProperties", "description": "The instance properties defining the VM instances to be created. Required\nif sourceInstanceTemplate is not provided." @@ -57911,6 +58092,46 @@ false }, "type": "object" }, +"InstanceFlexibilityPolicy": { +"description": "A flexible specification of machine types for instances to create.", +"id": "InstanceFlexibilityPolicy", +"properties": { +"instanceSelections": { +"additionalProperties": { +"$ref": "InstanceFlexibilityPolicyInstanceSelection" +}, +"description": "Specification of alternative, flexible instance subsets.\nOne of them will be selected to create the instances\nbased on various criteria, like:\n- ranks,\n- location policy,\n- current capacity,\n- available reservations (you can specify affinity in\nInstanceProperties),\n- SWAN/GOOSE limitations.\nKey is an arbitrary, unique RFC1035 string that identifies the instance\nselection.", +"type": "object" +} +}, +"type": "object" +}, +"InstanceFlexibilityPolicyInstanceSelection": { +"description": "Specification of machine type to use. Every position inside this message\nis an alternative.\nThe count specified in the shape flexibility must not exceed the number\nof entries in per_instance_properties or the capacity of the\nname_pattern, if used.", +"id": "InstanceFlexibilityPolicyInstanceSelection", +"properties": { +"disks": { +"description": "Disks to be attached to the instances created from in this selection.\nThey override the disks specified in the instance properties.", +"items": { +"$ref": "AttachedDisk" +}, +"type": "array" +}, +"machineTypes": { +"description": "Alternative machine types to use for instances that are created from\nthese properties. This field only accepts a machine type names, for\nexample `n2-standard-4` and not URLs or partial URLs.", +"items": { +"type": "string" +}, +"type": "array" +}, +"rank": { +"description": "Rank when prioritizing the shape flexibilities.\nThe instance selections with rank are considered\nfirst, in the ascending order of the rank.\nIf not set, defaults to 0.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "InstanceGroup": { "description": "Represents an Instance Group resource.\n\nInstance Groups can be used to configure a target forload\nbalancing.\n\nInstance groups can either be managed or unmanaged.\n\nTo create \nmanaged instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.\n\nUse zonal unmanaged instance groups if you need to applyload\nbalancing to groups of heterogeneous instances or if you need to manage\nthe instances yourself. You cannot create regional unmanaged instance groups.\n\nFor more information, readInstance\ngroups.", "id": "InstanceGroup", @@ -61874,7 +62095,7 @@ false "Public reportable behaviors", "", "", -"" +"Unrecoverable GPU error identified by an XID" ], "type": "string" }, @@ -63103,7 +63324,7 @@ false "type": "string" }, "bandwidth": { -"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s", +"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n \n - BPS_50M: 50 Mbit/s\n - BPS_100M: 100 Mbit/s\n - BPS_200M: 200 Mbit/s\n - BPS_300M: 300 Mbit/s\n - BPS_400M: 400 Mbit/s\n - BPS_500M: 500 Mbit/s\n - BPS_1G: 1 Gbit/s\n - BPS_2G: 2 Gbit/s\n - BPS_5G: 5 Gbit/s\n - BPS_10G: 10 Gbit/s\n - BPS_20G: 20 Gbit/s\n - BPS_50G: 50 Gbit/s\n - BPS_100G: 100 Gbit/s\n - BPS_400G: 400 Gbit/s", "enum": [ "BPS_100G", "BPS_100M", @@ -63113,6 +63334,7 @@ false "BPS_20G", "BPS_2G", "BPS_300M", +"BPS_400G", "BPS_400M", "BPS_500M", "BPS_50G", @@ -63128,6 +63350,7 @@ false "20 Gbit/s", "2 Gbit/s", "300 Mbit/s", +"400 Gbit/s", "400 Mbit/s", "500 Mbit/s", "50 Gbit/s", @@ -80915,6 +81138,295 @@ false }, "type": "object" }, +"ReservationSlot": { +"description": "Represents a reservation slot resource.", +"id": "ReservationSlot", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for this resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#reservationSlot", +"description": "Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. [Output Only] The name of the reservation slot.", +"readOnly": true, +"type": "string" +}, +"physicalTopology": { +"$ref": "ReservationSlotPhysicalTopology", +"deprecated": true, +"description": "Output only. [Output Only] The physical topology of the reservation slot.", +"readOnly": true +}, +"selfLink": { +"description": "Output only. [Output Only] A server-defined fully-qualified URL for this resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] A server-defined URL for this resource with the resource ID.", +"readOnly": true, +"type": "string" +}, +"shareSettings": { +"$ref": "ShareSettings", +"description": "Specify share settings to create a shared slot. Set to empty\nto inherit the share settings from a parent resource." +}, +"state": { +"description": "Output only. [Output Only] The state of the reservation slot.", +"enum": [ +"ACTIVE", +"CREATING", +"DELETING", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation slot has allocated all its resources.", +"The resources are being allocated for the reservation slot.", +"The reservation slot is currently being deleted.", +"" +], +"readOnly": true, +"type": "string" +}, +"status": { +"$ref": "ReservationSlotStatus", +"description": "Output only. [Output Only] The status of the reservation slot.", +"readOnly": true +}, +"zone": { +"description": "Output only. [Output Only] The zone in which the reservation slot resides.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReservationSlotPhysicalTopology": { +"id": "ReservationSlotPhysicalTopology", +"properties": { +"block": { +"description": "The unique identifier of the capacity block within the cluster.", +"type": "string" +}, +"cluster": { +"description": "The cluster name of the reservation sub-block.", +"type": "string" +}, +"host": { +"description": "The unique identifier of the capacity host within the capacity sub-block.", +"type": "string" +}, +"subBlock": { +"description": "The unique identifier of the capacity sub-block within the capacity\nblock.", +"type": "string" +} +}, +"type": "object" +}, +"ReservationSlotStatus": { +"id": "ReservationSlotStatus", +"properties": { +"physicalTopology": { +"$ref": "ReservationSlotPhysicalTopology", +"description": "Output only. [Output Only] The physical topology of the reservation sub-block.", +"readOnly": true +}, +"rdmaIpAddresses": { +"description": "Output only. The RDMA IP address of the physical host.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"runningInstances": { +"description": "Output only. The URIs of the instances currently running on this slot.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"ReservationSlotsGetResponse": { +"id": "ReservationSlotsGetResponse", +"properties": { +"resource": { +"$ref": "ReservationSlot" +} +}, +"type": "object" +}, +"ReservationSlotsListResponse": { +"description": "A list of reservation slots within a single reservation.", +"id": "ReservationSlotsListResponse", +"properties": { +"id": { +"description": "The unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of reservation slot resources.", +"items": { +"$ref": "ReservationSlot" +}, +"type": "array" +}, +"kind": { +"default": "compute#reservationSlot", +"description": "The type of resource. Alwayscompute#reservationSlot for a list of reservation\nslots.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "The server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "An informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "ReservationSubBlock": { "description": "Represents a reservation subBlock resource.", "id": "ReservationSubBlock", From fa6bd3165cfbee0b2b6162a978e273bd7242dcae Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 18/45] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPoint.properties.dialogflowInteractionMeasure.$ref (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorAssignedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorDroppedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorEscalatedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorMonitoredConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorTransferredToHumanAgentConvCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionNormalizedEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.avgConversationClientTurnSentimentEma (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationSuggestedSummaryRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalAgentMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalCustomerMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageAudioInAudioOutLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageEndToEndLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageLlmCallLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageTtsLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowAverageWebhookLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoInputRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoMatchRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookFailureRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookTimeoutRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchAgentQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchSuggestedQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionEditRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure (Total Keys: 7) - schemas.GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult (Total Keys: 8) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPoint.properties.dialogflowInteractionMeasure.$ref (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorAssignedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorDroppedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorEscalatedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorMonitoredConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorTransferredToHumanAgentConvCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionNormalizedEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.avgConversationClientTurnSentimentEma (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationSuggestedSummaryRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalAgentMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalCustomerMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageAudioInAudioOutLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageEndToEndLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageLlmCallLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageTtsLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowAverageWebhookLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoInputRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoMatchRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookFailureRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookTimeoutRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchAgentQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchSuggestedQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionEditRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure (Total Keys: 7) - schemas.GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult (Total Keys: 8) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPoint.properties.dialogflowInteractionMeasure.$ref (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorAssignedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorDroppedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorEscalatedConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorMonitoredConversationsCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aaSupervisorTransferredToHumanAgentConvCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionAgentUsageRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionCustomerMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.aiCoachSuggestionMessageTriggerRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.averageSummarizationSuggestionNormalizedEditDistance (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.avgConversationClientTurnSentimentEma (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.containedConversationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationAiCoachSuggestionRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationSuggestedSummaryRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalAgentMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationTotalCustomerMessageCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageAudioInAudioOutLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageEndToEndLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageLlmCallLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.conversationalAgentsAverageTtsLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowAverageWebhookLatency (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowConversationsEscalationRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoInputRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowInteractionsNoMatchRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookFailureRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.dialogflowWebhookTimeoutRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeAssistUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchAgentQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchNegativeFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchPositiveFeedbackRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchSuggestedQuerySourceRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.knowledgeSearchUriClickRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionEditRatio (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure.properties.summarizationSuggestionResultCount (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure (Total Keys: 7) - schemas.GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult (Total Keys: 8) --- .../documents/contactcenterinsights.v1.json | 836 +++++++++++++++++- 1 file changed, 835 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index a57d53cd7d..dca0e223b8 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -5453,7 +5453,7 @@ } } }, -"revision": "20260107", +"revision": "20260112", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -9948,6 +9948,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, +"dialogflowInteractionMeasure": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"description": "The measure related to dialogflow interactions." +}, "interval": { "$ref": "GoogleTypeInterval", "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." @@ -9959,6 +9963,66 @@ true "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { +"aaSupervisorAssignedConversationsCount": { +"description": "The number of conversations that were assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorDroppedConversationsCount": { +"description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorEscalatedConversationsCount": { +"description": "The number of conversations that were escalated to an AA human supervisor for intervention.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorMonitoredConversationsCount": { +"description": "The number of conversations scanned by the AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorTransferredToHumanAgentConvCount": { +"description": "The number of conversations transferred to a human agent.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentMessageTriggerCount": { +"description": "Count of agent messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageCount": { +"description": "Count of Ai Coach Suggestion that has been used by agents.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageRatio": { +"description": "Proportion of Ai Coach Suggestion that has been used by agents.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionCustomerMessageTriggerCount": { +"description": "Count of customer messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionCustomerMessageTriggerRatio": { +"description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionMessageTriggerCount": { +"description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionMessageTriggerRatio": { +"description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "format": "float", @@ -9994,22 +10058,187 @@ true "format": "float", "type": "number" }, +"averageSummarizationSuggestionEditDistance": { +"description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", +"format": "double", +"type": "number" +}, +"averageSummarizationSuggestionNormalizedEditDistance": { +"description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", +"format": "double", +"type": "number" +}, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, +"avgConversationClientTurnSentimentEma": { +"description": "The exponential moving average of the sentiment score of client turns in the conversation.", +"format": "double", +"type": "number" +}, +"containedConversationCount": { +"description": "The number of conversations that were contained.", +"format": "int32", +"type": "integer" +}, +"containedConversationRatio": { +"description": "The percentage of conversations that were contained.", +"format": "double", +"type": "number" +}, +"conversationAiCoachSuggestionCount": { +"description": "Count of conversations that has Ai Coach Suggestions.", +"format": "int32", +"type": "integer" +}, +"conversationAiCoachSuggestionRatio": { +"description": "Proportion of conversations that has Ai Coach Suggestions.", +"format": "double", +"type": "number" +}, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, +"conversationSuggestedSummaryRatio": { +"description": "Proportion of conversations that had a suggested summary.", +"format": "double", +"type": "number" +}, +"conversationTotalAgentMessageCount": { +"description": "The agent message count.", +"format": "int32", +"type": "integer" +}, +"conversationTotalCustomerMessageCount": { +"description": "The customer message count.", +"format": "int32", +"type": "integer" +}, +"conversationalAgentsAverageAudioInAudioOutLatency": { +"description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageEndToEndLatency": { +"description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageLlmCallLatency": { +"description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageTtsLatency": { +"description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"dialogflowAverageWebhookLatency": { +"description": "Average latency of dialogflow webhook calls.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationCount": { +"description": "count of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationRatio": { +"description": "Proportion of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoInputRatio": { +"description": "Proportion of dialogflow interactions that has empty input.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoMatchRatio": { +"description": "Proportion of dialogflow interactions that has no intent match for the input.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookFailureRatio": { +"description": "Proportion of dialogflow webhook calls that failed.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookTimeoutRatio": { +"description": "Proportion of dialogflow webhook calls that timed out.", +"format": "double", +"type": "number" +}, +"knowledgeAssistNegativeFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistPositiveFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistResultCount": { +"description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistUriClickRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, +"knowledgeSearchAgentQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchNegativeFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchPositiveFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchResultCount": { +"description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeSearchSuggestedQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchUriClickRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" +}, +"summarizationSuggestionEditRatio": { +"description": "Proportion of summarization suggestions that were manually edited.", +"format": "double", +"type": "number" +}, +"summarizationSuggestionResultCount": { +"description": "Count of summarization suggestions results.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -10030,6 +10259,55 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { +"description": "The measure related to dialogflow interactions.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"properties": { +"percentileAudioInAudioOutLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level." +}, +"percentileEndToEndLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." +}, +"percentileLlmCallLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." +}, +"percentileToolUseLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." +}, +"percentileTtsLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult": { +"description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", +"id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceDataPointPercentileResult", +"properties": { +"p50": { +"description": "The 50th percentile value.", +"format": "double", +"type": "number" +}, +"p90": { +"description": "The 90th percentile value.", +"format": "double", +"type": "number" +}, +"p99": { +"description": "The 99th percentile value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "id": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSliceTimeSeries", @@ -13770,6 +14048,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, +"dialogflowInteractionMeasure": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"description": "The measure related to dialogflow interactions." +}, "interval": { "$ref": "GoogleTypeInterval", "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." @@ -13781,6 +14063,66 @@ true "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasure", "properties": { +"aaSupervisorAssignedConversationsCount": { +"description": "The number of conversations that were assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorDroppedConversationsCount": { +"description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorEscalatedConversationsCount": { +"description": "The number of conversations that were escalated to an AA human supervisor for intervention.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorMonitoredConversationsCount": { +"description": "The number of conversations scanned by the AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorTransferredToHumanAgentConvCount": { +"description": "The number of conversations transferred to a human agent.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentMessageTriggerCount": { +"description": "Count of agent messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageCount": { +"description": "Count of Ai Coach Suggestion that has been used by agents.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageRatio": { +"description": "Proportion of Ai Coach Suggestion that has been used by agents.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionCustomerMessageTriggerCount": { +"description": "Count of customer messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionCustomerMessageTriggerRatio": { +"description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionMessageTriggerCount": { +"description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionMessageTriggerRatio": { +"description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "format": "float", @@ -13816,22 +14158,187 @@ true "format": "float", "type": "number" }, +"averageSummarizationSuggestionEditDistance": { +"description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", +"format": "double", +"type": "number" +}, +"averageSummarizationSuggestionNormalizedEditDistance": { +"description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", +"format": "double", +"type": "number" +}, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, +"avgConversationClientTurnSentimentEma": { +"description": "The exponential moving average of the sentiment score of client turns in the conversation.", +"format": "double", +"type": "number" +}, +"containedConversationCount": { +"description": "The number of conversations that were contained.", +"format": "int32", +"type": "integer" +}, +"containedConversationRatio": { +"description": "The percentage of conversations that were contained.", +"format": "double", +"type": "number" +}, +"conversationAiCoachSuggestionCount": { +"description": "Count of conversations that has Ai Coach Suggestions.", +"format": "int32", +"type": "integer" +}, +"conversationAiCoachSuggestionRatio": { +"description": "Proportion of conversations that has Ai Coach Suggestions.", +"format": "double", +"type": "number" +}, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, +"conversationSuggestedSummaryRatio": { +"description": "Proportion of conversations that had a suggested summary.", +"format": "double", +"type": "number" +}, +"conversationTotalAgentMessageCount": { +"description": "The agent message count.", +"format": "int32", +"type": "integer" +}, +"conversationTotalCustomerMessageCount": { +"description": "The customer message count.", +"format": "int32", +"type": "integer" +}, +"conversationalAgentsAverageAudioInAudioOutLatency": { +"description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageEndToEndLatency": { +"description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageLlmCallLatency": { +"description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageTtsLatency": { +"description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"dialogflowAverageWebhookLatency": { +"description": "Average latency of dialogflow webhook calls.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationCount": { +"description": "count of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationRatio": { +"description": "Proportion of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoInputRatio": { +"description": "Proportion of dialogflow interactions that has empty input.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoMatchRatio": { +"description": "Proportion of dialogflow interactions that has no intent match for the input.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookFailureRatio": { +"description": "Proportion of dialogflow webhook calls that failed.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookTimeoutRatio": { +"description": "Proportion of dialogflow webhook calls that timed out.", +"format": "double", +"type": "number" +}, +"knowledgeAssistNegativeFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistPositiveFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistResultCount": { +"description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistUriClickRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, +"knowledgeSearchAgentQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchNegativeFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchPositiveFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchResultCount": { +"description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeSearchSuggestedQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchUriClickRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" +}, +"summarizationSuggestionEditRatio": { +"description": "Proportion of summarization suggestions that were manually edited.", +"format": "double", +"type": "number" +}, +"summarizationSuggestionResultCount": { +"description": "Count of summarization suggestions results.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -13852,6 +14359,55 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { +"description": "The measure related to dialogflow interactions.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"properties": { +"percentileAudioInAudioOutLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level." +}, +"percentileEndToEndLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." +}, +"percentileLlmCallLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." +}, +"percentileToolUseLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." +}, +"percentileTtsLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult": { +"description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceDataPointPercentileResult", +"properties": { +"p50": { +"description": "The 50th percentile value.", +"format": "double", +"type": "number" +}, +"p90": { +"description": "The 90th percentile value.", +"format": "double", +"type": "number" +}, +"p99": { +"description": "The 99th percentile value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "id": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSliceTimeSeries", @@ -17528,6 +18084,10 @@ true "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "description": "The measure related to conversations." }, +"dialogflowInteractionMeasure": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"description": "The measure related to dialogflow interactions." +}, "interval": { "$ref": "GoogleTypeInterval", "description": "The interval that this data point represents. * If this is the total data point, the interval is [starting create time, ending create time) from the request. * If this a data point from the time series, the interval is [time, time + time granularity from the request)." @@ -17539,6 +18099,66 @@ true "description": "The measure related to conversations.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasure", "properties": { +"aaSupervisorAssignedConversationsCount": { +"description": "The number of conversations that were assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorDroppedConversationsCount": { +"description": "The number of conversations that were dropped, i.e. escalated but not assigned to an AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorEscalatedConversationsCount": { +"description": "The number of conversations that were escalated to an AA human supervisor for intervention.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorMonitoredConversationsCount": { +"description": "The number of conversations scanned by the AA human supervisor.", +"format": "int32", +"type": "integer" +}, +"aaSupervisorTransferredToHumanAgentConvCount": { +"description": "The number of conversations transferred to a human agent.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentMessageTriggerCount": { +"description": "Count of agent messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageCount": { +"description": "Count of Ai Coach Suggestion that has been used by agents.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionAgentUsageRatio": { +"description": "Proportion of Ai Coach Suggestion that has been used by agents.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionCustomerMessageTriggerCount": { +"description": "Count of customer messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionCustomerMessageTriggerRatio": { +"description": "Proportion of customer messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, +"aiCoachSuggestionMessageTriggerCount": { +"description": "Count of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "int32", +"type": "integer" +}, +"aiCoachSuggestionMessageTriggerRatio": { +"description": "Proportion of end_of_utterance trigger event messages that triggered an Ai Coach Suggestion.", +"format": "double", +"type": "number" +}, "averageAgentSentimentScore": { "description": "The average agent's sentiment score.", "format": "float", @@ -17574,22 +18194,187 @@ true "format": "float", "type": "number" }, +"averageSummarizationSuggestionEditDistance": { +"description": "Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.", +"format": "double", +"type": "number" +}, +"averageSummarizationSuggestionNormalizedEditDistance": { +"description": "Normalized Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion. Normalized edit distance is the average of (edit distance / summary length).", +"format": "double", +"type": "number" +}, "averageTurnCount": { "description": "The average turn count.", "format": "float", "type": "number" }, +"avgConversationClientTurnSentimentEma": { +"description": "The exponential moving average of the sentiment score of client turns in the conversation.", +"format": "double", +"type": "number" +}, +"containedConversationCount": { +"description": "The number of conversations that were contained.", +"format": "int32", +"type": "integer" +}, +"containedConversationRatio": { +"description": "The percentage of conversations that were contained.", +"format": "double", +"type": "number" +}, +"conversationAiCoachSuggestionCount": { +"description": "Count of conversations that has Ai Coach Suggestions.", +"format": "int32", +"type": "integer" +}, +"conversationAiCoachSuggestionRatio": { +"description": "Proportion of conversations that has Ai Coach Suggestions.", +"format": "double", +"type": "number" +}, "conversationCount": { "description": "The conversation count.", "format": "int32", "type": "integer" }, +"conversationSuggestedSummaryRatio": { +"description": "Proportion of conversations that had a suggested summary.", +"format": "double", +"type": "number" +}, +"conversationTotalAgentMessageCount": { +"description": "The agent message count.", +"format": "int32", +"type": "integer" +}, +"conversationTotalCustomerMessageCount": { +"description": "The customer message count.", +"format": "int32", +"type": "integer" +}, +"conversationalAgentsAverageAudioInAudioOutLatency": { +"description": "The average latency of conversational agents' audio in audio out latency per interaction. This is computed as the average of the all the interactions' audio in audio out latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageEndToEndLatency": { +"description": "The average latency of conversational agents' latency per interaction. This is computed as the average of the all the iteractions' end to end latencies in a conversation and averaged across conversations. The e2e latency is the time between the end of the user utterance and the start of the agent utterance on the interaction level.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageLlmCallLatency": { +"description": "The average latency of conversational agents' LLM call latency per interaction. This is computed as the average of the all the interactions LLM call latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"conversationalAgentsAverageTtsLatency": { +"description": "The macro average latency of conversational agents' TTS latency per interaction. This is computed as the average of the all the interactions' TTS latencies in a conversation and averaged across conversations.", +"format": "double", +"type": "number" +}, +"dialogflowAverageWebhookLatency": { +"description": "Average latency of dialogflow webhook calls.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationCount": { +"description": "count of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowConversationsEscalationRatio": { +"description": "Proportion of conversations that was handed off from virtual agent to human agent.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoInputRatio": { +"description": "Proportion of dialogflow interactions that has empty input.", +"format": "double", +"type": "number" +}, +"dialogflowInteractionsNoMatchRatio": { +"description": "Proportion of dialogflow interactions that has no intent match for the input.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookFailureRatio": { +"description": "Proportion of dialogflow webhook calls that failed.", +"format": "double", +"type": "number" +}, +"dialogflowWebhookTimeoutRatio": { +"description": "Proportion of dialogflow webhook calls that timed out.", +"format": "double", +"type": "number" +}, +"knowledgeAssistNegativeFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistPositiveFeedbackRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeAssistResultCount": { +"description": "Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeAssistUriClickRatio": { +"description": "Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, +"knowledgeSearchAgentQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchNegativeFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchPositiveFeedbackRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.", +"format": "double", +"type": "number" +}, +"knowledgeSearchResultCount": { +"description": "Count of knowledge search results (Generative Knowledge Assist) shown to the user.", +"format": "int32", +"type": "integer" +}, +"knowledgeSearchSuggestedQuerySourceRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.", +"format": "double", +"type": "number" +}, +"knowledgeSearchUriClickRatio": { +"description": "Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.", +"format": "double", +"type": "number" +}, "qaTagScores": { "description": "Average QA normalized score for all the tags.", "items": { "$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointConversationMeasureQaTagScore" }, "type": "array" +}, +"summarizationSuggestionEditRatio": { +"description": "Proportion of summarization suggestions that were manually edited.", +"format": "double", +"type": "number" +}, +"summarizationSuggestionResultCount": { +"description": "Count of summarization suggestions results.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -17610,6 +18395,55 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure": { +"description": "The measure related to dialogflow interactions.", +"id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointDialogflowInteractionMeasure", +"properties": { +"percentileAudioInAudioOutLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for audio in audio out latency in milliseconds per dialogflow interaction level." +}, +"percentileEndToEndLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for end to end chat latency in milliseconds per dialogflow interaction level." +}, +"percentileLlmCallLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for LLM latency in milliseconds per dialogflow interaction level." +}, +"percentileToolUseLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for tool use latency in milliseconds per dialogflow interaction level." +}, +"percentileTtsLatency": { +"$ref": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"description": "The percentile result for TTS latency in milliseconds per dialogflow interaction level." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult": { +"description": "The percentile result. Currently supported percentiles are 50th, 90th, and 99th.", +"id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceDataPointPercentileResult", +"properties": { +"p50": { +"description": "The 50th percentile value.", +"format": "double", +"type": "number" +}, +"p90": { +"description": "The 90th percentile value.", +"format": "double", +"type": "number" +}, +"p99": { +"description": "The 99th percentile value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries": { "description": "A time series of metric values.", "id": "GoogleCloudContactcenterinsightsV1mainQueryMetricsResponseSliceTimeSeries", From 262b107ad19faa91dee5892f4ff2269983f7ce96 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 19/45] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.BackfillAllStrategy.properties.spannerExcludedObjects.$ref (Total Keys: 1) - schemas.ConnectionProfile.properties.spannerProfile.$ref (Total Keys: 1) - schemas.DiscoverConnectionProfileRequest.properties.spannerDatabase.$ref (Total Keys: 1) - schemas.DiscoverConnectionProfileResponse.properties.spannerDatabase.$ref (Total Keys: 1) - schemas.SourceConfig.properties.spannerSourceConfig.$ref (Total Keys: 1) - schemas.SourceObjectIdentifier.properties.spannerIdentifier.$ref (Total Keys: 1) - schemas.SpannerColumn (Total Keys: 7) - schemas.SpannerDatabase (Total Keys: 4) - schemas.SpannerObjectIdentifier (Total Keys: 4) - schemas.SpannerProfile (Total Keys: 4) - schemas.SpannerSchema (Total Keys: 5) - schemas.SpannerSourceConfig (Total Keys: 12) - schemas.SpannerTable (Total Keys: 5) --- ...projects.locations.connectionProfiles.html | 60 ++++ ...astream_v1.projects.locations.streams.html | 288 ++++++++++++++++++ ...v1.projects.locations.streams.objects.html | 24 ++ .../documents/datastream.v1.json | 183 ++++++++++- 4 files changed, 554 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 7e2b4a2044..2cf089e844 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -249,6 +249,10 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "spannerProfile": { # Spanner profile. # Spanner Connection Profile configuration. + "database": "A String", # Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}. + "host": "A String", # Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com. + }, "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. "database": "A String", # Required. Database for the SQLServer connection. "hostname": "A String", # Required. Hostname for the SQLServer connection. @@ -487,6 +491,10 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "spannerProfile": { # Spanner profile. # Spanner Connection Profile configuration. + "database": "A String", # Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}. + "host": "A String", # Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com. + }, "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. "database": "A String", # Required. Database for the SQLServer connection. "hostname": "A String", # Required. Hostname for the SQLServer connection. @@ -617,6 +625,26 @@

Method Details

}, ], }, + "spannerDatabase": { # Spanner database structure. # Optional. Spanner database to enrich with child data objects and metadata. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerRdbms": { # SQLServer database structure. # Optional. SQLServer RDBMS to enrich with child data objects and metadata. "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -757,6 +785,26 @@

Method Details

}, ], }, + "spannerDatabase": { # Spanner database structure. # Enriched Spanner database. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerRdbms": { # SQLServer database structure. # Enriched SQLServer RDBMS object. "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -934,6 +982,10 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "spannerProfile": { # Spanner profile. # Spanner Connection Profile configuration. + "database": "A String", # Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}. + "host": "A String", # Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com. + }, "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. "database": "A String", # Required. Database for the SQLServer connection. "hostname": "A String", # Required. Hostname for the SQLServer connection. @@ -1114,6 +1166,10 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "spannerProfile": { # Spanner profile. # Spanner Connection Profile configuration. + "database": "A String", # Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}. + "host": "A String", # Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com. + }, "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. "database": "A String", # Required. Database for the SQLServer connection. "hostname": "A String", # Required. Hostname for the SQLServer connection. @@ -1303,6 +1359,10 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "spannerProfile": { # Spanner profile. # Spanner Connection Profile configuration. + "database": "A String", # Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}. + "host": "A String", # Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com. + }, "sqlServerProfile": { # SQLServer database profile. # SQLServer Connection Profile configuration. "database": "A String", # Required. Database for the SQLServer connection. "hostname": "A String", # Required. Hostname for the SQLServer connection. diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index b33e9d6982..98880377cc 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -225,6 +225,26 @@

Method Details

}, ], }, + "spannerExcludedObjects": { # Spanner database structure. # Spanner data source objects to avoid backfilling. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -358,6 +378,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -618,6 +642,54 @@

Method Details

"pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. }, "sourceConnectionProfile": "A String", # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` + "spannerSourceConfig": { # Spanner source configuration. # Spanner data source configuration. + "backfillDataBoostEnabled": True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. + "changeStreamName": "A String", # Required. Immutable. The change stream name to use for the stream. + "excludeObjects": { # Spanner database structure. # Optional. Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "fgacRole": "A String", # Optional. The FGAC role to use for the stream. + "includeObjects": { # Spanner database structure. # Optional. Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "maxConcurrentBackfillTasks": 42, # Optional. Maximum number of concurrent backfill tasks. + "maxConcurrentCdcTasks": 42, # Optional. Maximum number of concurrent CDC tasks. + "spannerRpcPriority": "A String", # Optional. The RPC priority to use for the stream. + }, "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. }, @@ -869,6 +941,26 @@

Method Details

}, ], }, + "spannerExcludedObjects": { # Spanner database structure. # Spanner data source objects to avoid backfilling. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -1002,6 +1094,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -1262,6 +1358,54 @@

Method Details

"pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. }, "sourceConnectionProfile": "A String", # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` + "spannerSourceConfig": { # Spanner source configuration. # Spanner data source configuration. + "backfillDataBoostEnabled": True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. + "changeStreamName": "A String", # Required. Immutable. The change stream name to use for the stream. + "excludeObjects": { # Spanner database structure. # Optional. Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "fgacRole": "A String", # Optional. The FGAC role to use for the stream. + "includeObjects": { # Spanner database structure. # Optional. Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "maxConcurrentBackfillTasks": 42, # Optional. Maximum number of concurrent backfill tasks. + "maxConcurrentCdcTasks": 42, # Optional. Maximum number of concurrent CDC tasks. + "spannerRpcPriority": "A String", # Optional. The RPC priority to use for the stream. + }, "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. }, @@ -1452,6 +1596,26 @@

Method Details

}, ], }, + "spannerExcludedObjects": { # Spanner database structure. # Spanner data source objects to avoid backfilling. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -1585,6 +1749,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -1845,6 +2013,54 @@

Method Details

"pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. }, "sourceConnectionProfile": "A String", # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` + "spannerSourceConfig": { # Spanner source configuration. # Spanner data source configuration. + "backfillDataBoostEnabled": True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. + "changeStreamName": "A String", # Required. Immutable. The change stream name to use for the stream. + "excludeObjects": { # Spanner database structure. # Optional. Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "fgacRole": "A String", # Optional. The FGAC role to use for the stream. + "includeObjects": { # Spanner database structure. # Optional. Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "maxConcurrentBackfillTasks": 42, # Optional. Maximum number of concurrent backfill tasks. + "maxConcurrentCdcTasks": 42, # Optional. Maximum number of concurrent CDC tasks. + "spannerRpcPriority": "A String", # Optional. The RPC priority to use for the stream. + }, "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. }, @@ -2042,6 +2258,26 @@

Method Details

}, ], }, + "spannerExcludedObjects": { # Spanner database structure. # Spanner data source objects to avoid backfilling. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, "sqlServerExcludedObjects": { # SQLServer database structure. # SQLServer data source objects to avoid backfilling "schemas": [ # SQLServer schemas in the database server. { # SQLServer schema. @@ -2175,6 +2411,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -2435,6 +2675,54 @@

Method Details

"pollingInterval": "A String", # Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be between 5 minutes and 24 hours. }, "sourceConnectionProfile": "A String", # Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}` + "spannerSourceConfig": { # Spanner source configuration. # Spanner data source configuration. + "backfillDataBoostEnabled": True or False, # Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set. + "changeStreamName": "A String", # Required. Immutable. The change stream name to use for the stream. + "excludeObjects": { # Spanner database structure. # Optional. Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "fgacRole": "A String", # Optional. The FGAC role to use for the stream. + "includeObjects": { # Spanner database structure. # Optional. Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown. + "schemas": [ # Optional. Spanner schemas in the database. + { # Spanner schema. + "schema": "A String", # Required. Schema name. + "tables": [ # Optional. Spanner tables in the schema. + { # Spanner table. + "columns": [ # Optional. Spanner columns in the table. + { # Spanner column. + "column": "A String", # Required. Column name. + "dataType": "A String", # Optional. Spanner data type. + "isPrimaryKey": True or False, # Optional. Whether or not the column is a primary key. + "ordinalPosition": "A String", # Optional. The ordinal position of the column in the table. + }, + ], + "table": "A String", # Required. Table name. + }, + ], + }, + ], + }, + "maxConcurrentBackfillTasks": 42, # Optional. Maximum number of concurrent backfill tasks. + "maxConcurrentCdcTasks": 42, # Optional. Maximum number of concurrent CDC tasks. + "spannerRpcPriority": "A String", # Optional. The RPC priority to use for the stream. + }, "sqlServerSourceConfig": { # SQLServer data source configuration # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. }, diff --git a/docs/dyn/datastream_v1.projects.locations.streams.objects.html b/docs/dyn/datastream_v1.projects.locations.streams.objects.html index 7bee091201..f59b656501 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.objects.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.objects.html @@ -192,6 +192,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -297,6 +301,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -352,6 +360,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -444,6 +456,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -554,6 +570,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. @@ -662,6 +682,10 @@

Method Details

"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. "objectName": "A String", # Required. The object name. }, + "spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. + "schema": "A String", # Optional. The schema name. + "table": "A String", # Required. The table name. + }, "sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. "schema": "A String", # Required. The schema name. "table": "A String", # Required. The table name. diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 0356613000..513ad55169 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1266,7 +1266,7 @@ } } }, -"revision": "20251231", +"revision": "20260107", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1305,6 +1305,10 @@ "$ref": "SalesforceOrg", "description": "Salesforce data source objects to avoid backfilling" }, +"spannerExcludedObjects": { +"$ref": "SpannerDatabase", +"description": "Spanner data source objects to avoid backfilling." +}, "sqlServerExcludedObjects": { "$ref": "SqlServerRdbms", "description": "SQLServer data source objects to avoid backfilling" @@ -1626,6 +1630,10 @@ "readOnly": true, "type": "boolean" }, +"spannerProfile": { +"$ref": "SpannerProfile", +"description": "Spanner Connection Profile configuration." +}, "sqlServerProfile": { "$ref": "SqlServerProfile", "description": "SQLServer Connection Profile configuration." @@ -1737,6 +1745,10 @@ "$ref": "SalesforceOrg", "description": "Optional. Salesforce organization to enrich with child data objects and metadata." }, +"spannerDatabase": { +"$ref": "SpannerDatabase", +"description": "Optional. Spanner database to enrich with child data objects and metadata." +}, "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "Optional. SQLServer RDBMS to enrich with child data objects and metadata." @@ -1768,6 +1780,10 @@ "$ref": "SalesforceOrg", "description": "Enriched Salesforce organization." }, +"spannerDatabase": { +"$ref": "SpannerDatabase", +"description": "Enriched Spanner database." +}, "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "Enriched SQLServer RDBMS object." @@ -3678,6 +3694,10 @@ "description": "Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", "type": "string" }, +"spannerSourceConfig": { +"$ref": "SpannerSourceConfig", +"description": "Spanner data source configuration." +}, "sqlServerSourceConfig": { "$ref": "SqlServerSourceConfig", "description": "SQLServer data source configuration." @@ -3724,6 +3744,10 @@ "$ref": "SalesforceObjectIdentifier", "description": "Salesforce data source object identifier." }, +"spannerIdentifier": { +"$ref": "SpannerObjectIdentifier", +"description": "Spanner data source object identifier." +}, "sqlServerIdentifier": { "$ref": "SqlServerObjectIdentifier", "description": "SQLServer data source object identifier." @@ -3731,6 +3755,163 @@ }, "type": "object" }, +"SpannerColumn": { +"description": "Spanner column.", +"id": "SpannerColumn", +"properties": { +"column": { +"description": "Required. Column name.", +"type": "string" +}, +"dataType": { +"description": "Optional. Spanner data type.", +"type": "string" +}, +"isPrimaryKey": { +"description": "Optional. Whether or not the column is a primary key.", +"type": "boolean" +}, +"ordinalPosition": { +"description": "Optional. The ordinal position of the column in the table.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"SpannerDatabase": { +"description": "Spanner database structure.", +"id": "SpannerDatabase", +"properties": { +"schemas": { +"description": "Optional. Spanner schemas in the database.", +"items": { +"$ref": "SpannerSchema" +}, +"type": "array" +} +}, +"type": "object" +}, +"SpannerObjectIdentifier": { +"description": "Spanner data source object identifier.", +"id": "SpannerObjectIdentifier", +"properties": { +"schema": { +"description": "Optional. The schema name.", +"type": "string" +}, +"table": { +"description": "Required. The table name.", +"type": "string" +} +}, +"type": "object" +}, +"SpannerProfile": { +"description": "Spanner profile.", +"id": "SpannerProfile", +"properties": { +"database": { +"description": "Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}.", +"type": "string" +}, +"host": { +"description": "Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com.", +"type": "string" +} +}, +"type": "object" +}, +"SpannerSchema": { +"description": "Spanner schema.", +"id": "SpannerSchema", +"properties": { +"schema": { +"description": "Required. Schema name.", +"type": "string" +}, +"tables": { +"description": "Optional. Spanner tables in the schema.", +"items": { +"$ref": "SpannerTable" +}, +"type": "array" +} +}, +"type": "object" +}, +"SpannerSourceConfig": { +"description": "Spanner source configuration.", +"id": "SpannerSourceConfig", +"properties": { +"backfillDataBoostEnabled": { +"description": "Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.", +"type": "boolean" +}, +"changeStreamName": { +"description": "Required. Immutable. The change stream name to use for the stream.", +"type": "string" +}, +"excludeObjects": { +"$ref": "SpannerDatabase", +"description": "Optional. Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown." +}, +"fgacRole": { +"description": "Optional. The FGAC role to use for the stream.", +"type": "string" +}, +"includeObjects": { +"$ref": "SpannerDatabase", +"description": "Optional. Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown." +}, +"maxConcurrentBackfillTasks": { +"description": "Optional. Maximum number of concurrent backfill tasks.", +"format": "int32", +"type": "integer" +}, +"maxConcurrentCdcTasks": { +"description": "Optional. Maximum number of concurrent CDC tasks.", +"format": "int32", +"type": "integer" +}, +"spannerRpcPriority": { +"description": "Optional. The RPC priority to use for the stream.", +"enum": [ +"SPANNER_RPC_PRIORITY_UNSPECIFIED", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Unspecified RPC priority.", +"Low RPC priority.", +"Medium RPC priority.", +"High RPC priority." +], +"type": "string" +} +}, +"type": "object" +}, +"SpannerTable": { +"description": "Spanner table.", +"id": "SpannerTable", +"properties": { +"columns": { +"description": "Optional. Spanner columns in the table.", +"items": { +"$ref": "SpannerColumn" +}, +"type": "array" +}, +"table": { +"description": "Required. Table name.", +"type": "string" +} +}, +"type": "object" +}, "SpecificStartPosition": { "description": "CDC strategy to start replicating from a specific position in the source.", "id": "SpecificStartPosition", From be60d89795c1a529d967a52d2225eb7638570360 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:37 +0000 Subject: [PATCH 20/45] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1Engine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.addPatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.deletePatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.removePatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.replacePatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.addPatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.deletePatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.removePatientFilter (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.replacePatientFilter (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1Engine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1HealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata (Total Keys: 10) - schemas.GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.knowledgeGraphConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig (Total Keys: 15) - schemas.GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig.properties.initialFilterGroups (Total Keys: 2) --- ...ects.locations.collections.dataStores.html | 15 + ...rojects.locations.collections.engines.html | 80 +++ ...ine_v1.projects.locations.collections.html | 9 + ...gine_v1.projects.locations.dataStores.html | 15 + ...discoveryengine_v1.projects.locations.html | 6 + ...pha.projects.locations.authorizations.html | 12 +- ...ects.locations.collections.dataStores.html | 204 +++++++ ...rojects.locations.collections.engines.html | 112 ++++ ...1alpha.projects.locations.collections.html | 18 + ...v1alpha.projects.locations.dataStores.html | 204 +++++++ ...veryengine_v1alpha.projects.locations.html | 6 + ...ects.locations.collections.dataStores.html | 15 + ...rojects.locations.collections.engines.html | 112 ++++ ..._v1beta.projects.locations.dataStores.html | 15 + .../documents/discoveryengine.v1.json | 295 +++++++++- .../documents/discoveryengine.v1alpha.json | 529 +++++++++++++++++- .../documents/discoveryengine.v1beta.json | 295 +++++++++- 17 files changed, 1932 insertions(+), 10 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index cfdcd0a300..36652df182 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -329,6 +329,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -546,6 +549,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -719,6 +725,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -880,6 +889,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -1023,6 +1035,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index ddb0275655..387a3bf644 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -193,6 +193,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -347,6 +363,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -442,6 +474,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -544,6 +592,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -628,6 +692,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index 0286b78271..9af3a037d2 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -239,6 +239,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -438,6 +441,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -636,6 +642,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index dd9c5defda..5d5fd07792 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -321,6 +321,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -538,6 +541,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -711,6 +717,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -872,6 +881,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -1015,6 +1027,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index fda89b33b3..4d624af002 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -301,6 +301,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -529,6 +532,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html index 8127e38b96..61b5c1a5e1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html @@ -118,7 +118,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. @@ -142,7 +142,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. @@ -190,7 +190,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. @@ -224,7 +224,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. @@ -266,7 +266,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. @@ -290,7 +290,7 @@

Method Details

"clientId": "A String", # Required. The OAuth2 client ID. "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest. "pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/ - "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + "scopes": [ # Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization. "A String", ], "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 7d00cec6ca..1c6a354259 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -149,6 +149,9 @@

Instance Methods

Returns the widgetConfigs Resource.

+

+ addPatientFilter(dataStore, body=None, x__xgafv=None)

+

Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.

close()

Close httplib2 connections.

@@ -161,6 +164,9 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a DataStore.

+

+ deletePatientFilter(dataStore, body=None, x__xgafv=None)

+

Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.

get(name, x__xgafv=None)

Gets a DataStore.

@@ -179,6 +185,12 @@

Instance Methods

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

Updates a DataStore

+

+ removePatientFilter(dataStore, body=None, x__xgafv=None)

+

Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.

+

+ replacePatientFilter(dataStore, body=None, x__xgafv=None)

+

Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.

trainCustomModel(dataStore, body=None, x__xgafv=None)

Trains a custom model.

@@ -186,6 +198,51 @@

Instance Methods

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

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.

Method Details

+
+ addPatientFilter(dataStore, body=None, x__xgafv=None) +
Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.AddPatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -335,6 +392,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -466,6 +526,48 @@

Method Details

}
+
+ deletePatientFilter(dataStore, body=None, x__xgafv=None) +
Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.DeletePatientFilters method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Gets a DataStore.
@@ -584,6 +686,9 @@ 

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -872,6 +977,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1065,6 +1173,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1240,6 +1351,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1303,6 +1417,96 @@

Method Details

}
+
+ removePatientFilter(dataStore, body=None, x__xgafv=None) +
Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.RemovePatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ replacePatientFilter(dataStore, body=None, x__xgafv=None) +
Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.ReplacePatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
trainCustomModel(dataStore, body=None, x__xgafv=None)
Trains a custom model.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
index 910c48df2e..35fcf15ad1 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
@@ -210,6 +210,22 @@ 

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -373,6 +389,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -496,6 +528,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -607,6 +655,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -700,6 +764,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -805,6 +885,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -910,6 +1006,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 30ffffc1e8..61291a6cf1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -253,6 +253,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -480,6 +483,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -711,6 +717,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -952,6 +961,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -1203,6 +1215,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -1421,6 +1436,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 6b8b6aa560..fbb8e4eb14 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -144,6 +144,9 @@

Instance Methods

Returns the widgetConfigs Resource.

+

+ addPatientFilter(dataStore, body=None, x__xgafv=None)

+

Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.

close()

Close httplib2 connections.

@@ -156,6 +159,9 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a DataStore.

+

+ deletePatientFilter(dataStore, body=None, x__xgafv=None)

+

Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.

get(name, x__xgafv=None)

Gets a DataStore.

@@ -174,10 +180,61 @@

Instance Methods

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

Updates a DataStore

+

+ removePatientFilter(dataStore, body=None, x__xgafv=None)

+

Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.

+

+ replacePatientFilter(dataStore, body=None, x__xgafv=None)

+

Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.

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

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.

Method Details

+
+ addPatientFilter(dataStore, body=None, x__xgafv=None) +
Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.AddPatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -327,6 +384,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -458,6 +518,48 @@

Method Details

}
+
+ deletePatientFilter(dataStore, body=None, x__xgafv=None) +
Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.DeletePatientFilters method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Gets a DataStore.
@@ -576,6 +678,9 @@ 

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -864,6 +969,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1057,6 +1165,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1232,6 +1343,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "idpConfig": { # Identity Provider Config. # Output only. Data store level identity provider config. @@ -1295,6 +1409,96 @@

Method Details

}
+
+ removePatientFilter(dataStore, body=None, x__xgafv=None) +
Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.RemovePatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ replacePatientFilter(dataStore, body=None, x__xgafv=None) +
Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
+
+Args:
+  dataStore: string, Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataStoreService.ReplacePatientFilter method.
+  "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
+  "filterGroups": [ # Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
updateDocumentProcessingConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
index 1f193dc8b2..9cc2b61ec3 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
@@ -1078,6 +1078,9 @@ 

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. @@ -1326,6 +1329,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format. "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index aafd0dc227..7ed62b1dd1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -324,6 +324,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -547,6 +550,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -726,6 +732,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -893,6 +902,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -1042,6 +1054,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 112283c4e4..4ec8e8765e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -197,6 +197,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -351,6 +367,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -446,6 +478,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -548,6 +596,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -632,6 +696,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -728,6 +808,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. @@ -824,6 +920,22 @@

Method Details

"a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. + "knowledgeGraphConfig": { # Configuration message for the Knowledge Graph. # Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + "cloudKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + "enableCloudKnowledgeGraph": True or False, # Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. + "enablePrivateKnowledgeGraph": True or False, # Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. + "featureConfig": { # Feature config for the Knowledge Graph. # Optional. Feature config for the Knowledge Graph. + "disablePrivateKgAutoComplete": True or False, # Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. + "disablePrivateKgEnrichment": True or False, # Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. + "disablePrivateKgQueryUiChips": True or False, # Whether to disable the private KG for query UI chips. Defaults to false if not specified. + "disablePrivateKgQueryUnderstanding": True or False, # Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. + }, + "privateKnowledgeGraphTypes": [ # Specify entity types to support. + "A String", + ], + }, "mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. "engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config. "mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index dfb2b254d6..34f7d0a52d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -316,6 +316,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -539,6 +542,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -718,6 +724,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -885,6 +894,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. @@ -1034,6 +1046,9 @@

Method Details

"healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical. "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume. + "initialFilterGroups": [ # Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources. + "A String", + ], }, "identityMappingStore": "A String", # Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. "industryVertical": "A String", # Immutable. The industry vertical that the data store registers. diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index e9e16b7a9c..588fc39cc2 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -8801,7 +8801,7 @@ } } }, -"revision": "20260107", +"revision": "20260112", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14442,6 +14442,10 @@ ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -14562,6 +14566,62 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", @@ -14906,6 +14966,13 @@ "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -19904,6 +19971,24 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest": { +"description": "Request for DataStoreService.AddPatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", @@ -22751,6 +22836,17 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest": { +"description": "Request for DataStoreService.DeletePatientFilters method.", +"id": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { "description": "Metadata for DeleteSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", @@ -23170,6 +23266,10 @@ false ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -23299,6 +23399,62 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", @@ -23865,6 +24021,13 @@ false "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -24486,6 +24649,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata": { +"description": "Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"filtersAddedCount": { +"description": "The number of patient IDs added to the patient filter.", +"format": "int64", +"type": "string" +}, +"filtersRemovedCount": { +"description": "The number of patient IDs removed from the patient filter.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -25048,6 +25238,42 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest": { +"description": "Request for DataStoreService.RemovePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest": { +"description": "Request for DataStoreService.ReplacePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -27973,6 +28199,10 @@ false ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -28093,6 +28323,62 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", @@ -28355,6 +28641,13 @@ false "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 991f9b6f88..eed2801bb2 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -1505,6 +1505,35 @@ }, "dataStores": { "methods": { +"addPatientFilter": { +"description": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:addPatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.addPatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:addPatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "completeQuery": { "description": "Completes the specified user input with keyword suggestions.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:completeQuery", @@ -1634,6 +1663,35 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"deletePatientFilter": { +"description": "Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:deletePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.deletePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:deletePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "get": { "description": "Gets a DataStore.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}", @@ -1790,6 +1848,64 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"removePatientFilter": { +"description": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:removePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.removePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:removePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"replacePatientFilter": { +"description": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:replacePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.replacePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:replacePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "trainCustomModel": { "description": "Trains a custom model.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", @@ -7272,6 +7388,35 @@ }, "dataStores": { "methods": { +"addPatientFilter": { +"description": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:addPatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.addPatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:addPatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "completeQuery": { "description": "Completes the specified user input with keyword suggestions.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery", @@ -7401,6 +7546,35 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"deletePatientFilter": { +"description": "Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:deletePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.deletePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:deletePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "get": { "description": "Gets a DataStore.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", @@ -7557,6 +7731,64 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"removePatientFilter": { +"description": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:removePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.removePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:removePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"replacePatientFilter": { +"description": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:replacePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.replacePatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:replacePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "updateDocumentProcessingConfig": { "description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", @@ -12111,7 +12343,7 @@ } } }, -"revision": "20260107", +"revision": "20260112", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14637,6 +14869,10 @@ ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -14757,6 +14993,62 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", @@ -14929,6 +15221,13 @@ "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -16549,6 +16848,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest": { +"description": "Request for DataStoreService.AddPatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition": { "description": "Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).", "id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", @@ -19343,7 +19660,7 @@ "type": "boolean" }, "scopes": { -"description": "Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`", +"description": "Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization.", "items": { "type": "string" }, @@ -22443,6 +22760,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest": { +"description": "Request for DataStoreService.DeletePatientFilters method.", +"id": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { "description": "Metadata for DeleteSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", @@ -23126,6 +23454,10 @@ ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -23255,6 +23587,62 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", @@ -24292,6 +24680,13 @@ "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -25934,6 +26329,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata": { +"description": "Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"filtersAddedCount": { +"description": "The number of patient IDs added to the patient filter.", +"format": "int64", +"type": "string" +}, +"filtersRemovedCount": { +"description": "The number of patient IDs removed from the patient filter.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { "description": "Request for pausing training of an engine.", "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", @@ -26963,6 +27385,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest": { +"description": "Request for DataStoreService.RemovePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest": { "description": "Request message for CompletionService.RemoveSuggestion method.", "id": "GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest", @@ -26997,6 +27437,24 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest": { +"description": "Request for DataStoreService.ReplacePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaReply": { "description": "Defines a reply message to user.", "id": "GoogleCloudDiscoveryengineV1alphaReply", @@ -32713,6 +33171,10 @@ false ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -32833,6 +33295,62 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", @@ -33095,6 +33613,13 @@ false "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 2ba48329c3..48ac5d9a3f 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9106,7 +9106,7 @@ } } }, -"revision": "20260107", +"revision": "20260112", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11632,6 +11632,10 @@ ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -11752,6 +11756,62 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig", @@ -11924,6 +11984,13 @@ "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -13492,6 +13559,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest": { +"description": "Request for DataStoreService.AddPatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig", @@ -16339,6 +16424,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest": { +"description": "Request for DataStoreService.DeletePatientFilters method.", +"id": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { "description": "Metadata for DeleteSchema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", @@ -16758,6 +16854,10 @@ ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -16887,6 +16987,62 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", @@ -17453,6 +17609,13 @@ "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -18074,6 +18237,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata": { +"description": "Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"filtersAddedCount": { +"description": "The number of patient IDs added to the patient filter.", +"format": "int64", +"type": "string" +}, +"filtersRemovedCount": { +"description": "The number of patient IDs removed from the patient filter.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -18636,6 +18826,42 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest": { +"description": "Request for DataStoreService.RemovePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest": { +"description": "Request for DataStoreService.ReplacePatientFilter method.", +"id": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"type": "string" +}, +"filterGroups": { +"description": "Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -25045,6 +25271,10 @@ false ], "type": "string" }, +"knowledgeGraphConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"description": "Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, "mediaRecommendationEngineConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." @@ -25165,6 +25395,62 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig": { +"description": "Configuration message for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig", +"properties": { +"cloudKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +}, +"enableCloudKnowledgeGraph": { +"description": "Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"enablePrivateKnowledgeGraph": { +"description": "Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"featureConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"description": "Optional. Feature config for the Knowledge Graph." +}, +"privateKnowledgeGraphTypes": { +"description": "Specify entity types to support.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig": { +"description": "Feature config for the Knowledge Graph.", +"id": "GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig", +"properties": { +"disablePrivateKgAutoComplete": { +"description": "Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgEnrichment": { +"description": "Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUiChips": { +"description": "Whether to disable the private KG for query UI chips. Defaults to false if not specified.", +"type": "boolean" +}, +"disablePrivateKgQueryUnderstanding": { +"description": "Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig": { "description": "Additional config specs for a Media Recommendation engine.", "id": "GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig", @@ -25599,6 +25885,13 @@ false "enableStaticIndexingForBatchIngestion": { "description": "Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.", "type": "boolean" +}, +"initialFilterGroups": { +"description": "Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 5602a022cd0c751a33d5a7102345d1551431ad0f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 21/45] feat(firebaseappcheck): update the api #### firebaseappcheck:v1beta The following keys were added: - schemas.GoogleFirebaseAppcheckV1betaExchangeCustomTokenRequest.properties.jti.type (Total Keys: 1) --- docs/dyn/firebaseappcheck_v1beta.projects.apps.html | 1 + .../discovery_cache/documents/firebaseappcheck.v1beta.json | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html index 4157ade100..7079e0a445 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html @@ -239,6 +239,7 @@

Method Details

{ # Request message for the ExchangeCustomToken method. "customToken": "A String", # Required. A custom token signed using your project's Admin SDK service account credentials. + "jti": "A String", # Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, neither the presence nor the contents of the `jti` claim in the returned App Check token is specified. To ensure that the returned App Check token is eligible for limited use functionality, set `limited_use` to `true`. "limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`. } diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 540dd9b8ba..3f8a2de058 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1823,7 +1823,7 @@ } } }, -"revision": "20250901", +"revision": "20260110", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -2181,6 +2181,10 @@ "description": "Required. A custom token signed using your project's Admin SDK service account credentials.", "type": "string" }, +"jti": { +"description": "Optional. When `limited_use` is set to `true`, this field specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. *Limited use* App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. An error is returned if this field is specified without setting `limited_use` to `true`. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty and `limited_use` is set to `true`, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks. When `limited_use` is set to `false`, neither the presence nor the contents of the `jti` claim in the returned App Check token is specified. To ensure that the returned App Check token is eligible for limited use functionality, set `limited_use` to `true`.", +"type": "string" +}, "limitedUse": { "description": "Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`.", "type": "boolean" From 741900741152bb650a3c92a6e4d3bc3ac47ff0ff Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 22/45] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1 The following keys were added: - schemas.GdataBlobstore2Info.properties.uploadFragmentListCreationInfo (Total Keys: 2) --- docs/dyn/firebaseappdistribution_v1.media.html | 8 ++++++++ .../documents/firebaseappdistribution.v1.json | 7 ++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseappdistribution_v1.media.html b/docs/dyn/firebaseappdistribution_v1.media.html index 66fed7636f..2afc2a6941 100644 --- a/docs/dyn/firebaseappdistribution_v1.media.html +++ b/docs/dyn/firebaseappdistribution_v1.media.html @@ -106,6 +106,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. @@ -117,6 +118,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -153,6 +155,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -178,6 +181,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -206,6 +210,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -232,6 +237,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -256,6 +262,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -284,6 +291,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 8b4af7c1fd..baafeb3cd9 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -946,7 +946,7 @@ } } }, -"revision": "20251203", +"revision": "20260113", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -976,6 +976,11 @@ "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", "type": "string" }, +"uploadFragmentListCreationInfo": { +"description": "A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", +"format": "byte", +"type": "string" +}, "uploadMetadataContainer": { "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", "format": "byte", From 8084fa13d244a759b35b04f700269024977773b0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 23/45] feat(firebaseapphosting): update the api #### firebaseapphosting:v1 The following keys were added: - schemas.Config.properties.effectiveEnv (Total Keys: 3) - schemas.EnvironmentVariable.properties.origin (Total Keys: 4) #### firebaseapphosting:v1beta The following keys were added: - schemas.Config.properties.effectiveEnv (Total Keys: 3) - schemas.EnvironmentVariable.properties.origin (Total Keys: 4) --- ...v1.projects.locations.backends.builds.html | 42 +++++++++++++++ ...ta.projects.locations.backends.builds.html | 54 ++++++++++++++++--- ...ng_v1beta.projects.locations.backends.html | 8 +++ .../documents/firebaseapphosting.v1.json | 34 +++++++++++- .../documents/firebaseapphosting.v1beta.json | 38 +++++++++++-- 5 files changed, 166 insertions(+), 10 deletions(-) diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html index 6bb7c77b77..f12f037434 100644 --- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html +++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html @@ -113,11 +113,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -282,11 +296,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -389,11 +417,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html index 8731d3db59..bfce3e080b 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html @@ -113,11 +113,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -135,7 +149,7 @@

Method Details

"deleteTime": "A String", # Output only. Time at which the build was deleted. "displayName": "A String", # Optional. Human-readable name. 63 character limit. "environment": "A String", # Output only. The environment name of the backend when this build was created. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -144,7 +158,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. }, - "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. { # The container for the rpc status and source for any errors found during the build process. "cloudResource": "A String", # Output only. Resource link @@ -292,11 +306,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -314,7 +342,7 @@

Method Details

"deleteTime": "A String", # Output only. Time at which the build was deleted. "displayName": "A String", # Optional. Human-readable name. 63 character limit. "environment": "A String", # Output only. The environment name of the backend when this build was created. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -323,7 +351,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. }, - "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. { # The container for the rpc status and source for any errors found during the build process. "cloudResource": "A String", # Output only. Resource link @@ -409,11 +437,25 @@

Method Details

}, "buildLogsUri": "A String", # Output only. The location of the [Cloud Build logs](https://cloud.google.com/build/docs/view-build-results) for the build process. "config": { # Additional configuration of the backend for this build. # Optional. Additional configuration of the service. + "effectiveEnv": [ # Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin` + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error { # Environment variables for this build. "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -431,7 +473,7 @@

Method Details

"deleteTime": "A String", # Output only. Time at which the build was deleted. "displayName": "A String", # Optional. Human-readable name. 63 character limit. "environment": "A String", # Output only. The environment name of the backend when this build was created. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. { @@ -440,7 +482,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. }, - "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead. + "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead. "errors": [ # Output only. A list of all errors that occurred during an App Hosting build. { # The container for the rpc status and source for any errors found during the build process. "cloudResource": "A String", # Output only. Resource link diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html index 49a82435d7..1f1832447d 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html @@ -161,6 +161,8 @@

Method Details

"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -291,6 +293,8 @@

Method Details

"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -358,6 +362,8 @@

Method Details

"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run @@ -433,6 +439,8 @@

Method Details

"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. "A String", ], + "origin": "A String", # Output only. The high-level origin category of the environment variable. + "originFileName": "A String", # Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as "apphosting.yaml" or "apphosting.staging.yaml". "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json index 97e21358c7..a323dafa99 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json @@ -1106,7 +1106,7 @@ } } }, -"revision": "20251113", +"revision": "20260108", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -1454,6 +1454,14 @@ "description": "Additional configuration of the backend for this build.", "id": "Config", "properties": { +"effectiveEnv": { +"description": "Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin`", +"items": { +"$ref": "EnvironmentVariable" +}, +"readOnly": true, +"type": "array" +}, "env": { "description": "Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error", "items": { @@ -1969,6 +1977,30 @@ }, "type": "array" }, +"origin": { +"description": "Output only. The high-level origin category of the environment variable.", +"enum": [ +"ORIGIN_UNSPECIFIED", +"BACKEND_OVERRIDES", +"BUILD_CONFIG", +"APPHOSTING_YAML", +"FIREBASE_SYSTEM" +], +"enumDescriptions": [ +"Source is unspecified.", +"Variable was set on the backend resource (e.g. via API or Console). Represents variables from `Backend.override_env`", +"Variable was provided specifically for the build upon creation via the `Build.Config.env` field. Only used for pre-built images.", +"Variable is defined in apphosting.yaml file.", +"Variable is defined provided by the firebase platform." +], +"readOnly": true, +"type": "string" +}, +"originFileName": { +"description": "Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as \"apphosting.yaml\" or \"apphosting.staging.yaml\".", +"readOnly": true, +"type": "string" +}, "secret": { "description": "A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json index da3481c7dc..bdf9e569fe 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json @@ -1103,7 +1103,7 @@ } } }, -"revision": "20251113", +"revision": "20260108", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -1298,12 +1298,12 @@ "error": { "$ref": "Status", "deprecated": true, -"description": "Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated. Use `errors` instead.", +"description": "Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.", "readOnly": true }, "errorSource": { "deprecated": true, -"description": "Output only. The source of the error for the build, if in a `FAILED` state. Deprecated. Use `errors` instead.", +"description": "Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.", "enum": [ "ERROR_SOURCE_UNSPECIFIED", "CLOUD_BUILD", @@ -1474,6 +1474,14 @@ "description": "Additional configuration of the backend for this build.", "id": "Config", "properties": { +"effectiveEnv": { +"description": "Output only. [OUTPUT_ONLY] This field represents all environment variables employed during both the build and runtime. This list reflects the result of merging variables from all sources (Backend.override_env, Build.Config.env, YAML, defaults, system). Each variable includes its `origin`", +"items": { +"$ref": "EnvironmentVariable" +}, +"readOnly": true, +"type": "array" +}, "env": { "description": "Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error", "items": { @@ -1995,6 +2003,30 @@ }, "type": "array" }, +"origin": { +"description": "Output only. The high-level origin category of the environment variable.", +"enum": [ +"ORIGIN_UNSPECIFIED", +"BACKEND_OVERRIDES", +"BUILD_CONFIG", +"APPHOSTING_YAML", +"FIREBASE_SYSTEM" +], +"enumDescriptions": [ +"Source is unspecified.", +"Variable was set on the backend resource (e.g. via API or Console). Represents variables from `Backend.override_env`", +"Variable was provided specifically for the build upon creation via the `Build.Config.env` field. Only used for pre-built images.", +"Variable is defined in apphosting.yaml file.", +"Variable is defined provided by the firebase platform." +], +"readOnly": true, +"type": "string" +}, +"originFileName": { +"description": "Output only. Specific detail about the source. For APPHOSTING_YAML origins, this will contain the exact filename, such as \"apphosting.yaml\" or \"apphosting.staging.yaml\".", +"readOnly": true, +"type": "string" +}, "secret": { "description": "A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret.", "type": "string" From a6a45f9c3c470ce25db1baf8a86d8bef4c698461 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 24/45] feat(firebasedataconnect): update the api #### firebasedataconnect:v1 The following keys were added: - schemas.Datasource.properties.httpGraphql.$ref (Total Keys: 1) - schemas.HttpGraphql (Total Keys: 5) #### firebasedataconnect:v1beta The following keys were added: - schemas.Datasource.properties.httpGraphql.$ref (Total Keys: 1) - schemas.HttpGraphql (Total Keys: 5) --- ...nect_v1.projects.locations.operations.html | 4 +-- ...1.projects.locations.services.schemas.html | 16 ++++++++++++ ..._v1beta.projects.locations.operations.html | 4 +-- ...a.projects.locations.services.schemas.html | 16 ++++++++++++ .../documents/firebasedataconnect.v1.json | 26 ++++++++++++++++--- .../documents/firebasedataconnect.v1beta.json | 26 ++++++++++++++++--- 6 files changed, 82 insertions(+), 10 deletions(-) diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html b/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html index a2712ef5b2..87ad1710e3 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html @@ -184,7 +184,7 @@

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. - returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -216,7 +216,7 @@

Method Details

}, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. "A String", ], }
diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html index d05c61156f..7eb4088bc9 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html @@ -117,6 +117,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -241,6 +245,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -301,6 +309,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -368,6 +380,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html index d18a868bc9..9117adc7bb 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html @@ -184,7 +184,7 @@

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. - returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -216,7 +216,7 @@

Method Details

}, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. "A String", ], }
diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html index 98ed415d28..7748a7a90b 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html @@ -117,6 +117,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -241,6 +245,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -301,6 +309,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` @@ -368,6 +380,10 @@

Method Details

"createTime": "A String", # Output only. [Output only] Create time stamp. "datasources": [ # Required. The data sources linked in the schema. { # A data source that backs Firebase Data Connect services. + "httpGraphql": { # Settings for HTTP GraphQL server webhook. # HTTP GraphQL server webhook configurations. + "timeout": "A String", # Optional. Timeout duration for the HTTP request. + "uri": "A String", # Required. The endpoint of the HTTP GraphQL server. + }, "postgresql": { # Settings for PostgreSQL data source. # PostgreSQL configurations. "cloudSql": { # Settings for CloudSQL instance configuration. # Cloud SQL configurations. "instance": "A String", # Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ``` diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json index e2b598bee2..b9ab9fc0f1 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json @@ -296,7 +296,7 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"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" } @@ -1165,7 +1165,7 @@ } } }, -"revision": "20251026", +"revision": "20260111", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1249,6 +1249,10 @@ "description": "A data source that backs Firebase Data Connect services.", "id": "Datasource", "properties": { +"httpGraphql": { +"$ref": "HttpGraphql", +"description": "HTTP GraphQL server webhook configurations." +}, "postgresql": { "$ref": "PostgreSql", "description": "PostgreSQL configurations." @@ -1530,6 +1534,22 @@ }, "type": "object" }, +"HttpGraphql": { +"description": "Settings for HTTP GraphQL server webhook.", +"id": "HttpGraphql", +"properties": { +"timeout": { +"description": "Optional. Timeout duration for the HTTP request.", +"format": "google-duration", +"type": "string" +}, +"uri": { +"description": "Required. The endpoint of the HTTP GraphQL server.", +"type": "string" +} +}, +"type": "object" +}, "ImpersonateRequest": { "description": "The Impersonate request to Firebase Data Connect.", "id": "ImpersonateRequest", @@ -1635,7 +1655,7 @@ "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json index d9fc87bcd0..36de8718b2 100644 --- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json @@ -296,7 +296,7 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"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" } @@ -1165,7 +1165,7 @@ } } }, -"revision": "20251026", +"revision": "20260111", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1249,6 +1249,10 @@ "description": "A data source that backs Firebase Data Connect services.", "id": "Datasource", "properties": { +"httpGraphql": { +"$ref": "HttpGraphql", +"description": "HTTP GraphQL server webhook configurations." +}, "postgresql": { "$ref": "PostgreSql", "description": "PostgreSQL configurations." @@ -1530,6 +1534,22 @@ }, "type": "object" }, +"HttpGraphql": { +"description": "Settings for HTTP GraphQL server webhook.", +"id": "HttpGraphql", +"properties": { +"timeout": { +"description": "Optional. Timeout duration for the HTTP request.", +"format": "google-duration", +"type": "string" +}, +"uri": { +"description": "Required. The endpoint of the HTTP GraphQL server.", +"type": "string" +} +}, +"type": "object" +}, "ImpersonateRequest": { "description": "The Impersonate request to Firebase Data Connect.", "id": "ImpersonateRequest", @@ -1635,7 +1655,7 @@ "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, From a73e766c48075a3900377f109231f35ed702ea83 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 25/45] feat(gkebackup): update the api #### gkebackup:v1 The following keys were added: - resources.projects.resources.locations.resources.backupPlans.methods.getTags (Total Keys: 11) - resources.projects.resources.locations.resources.backupPlans.methods.setTags (Total Keys: 12) - resources.projects.resources.locations.resources.restorePlans.methods.getTags (Total Keys: 11) - resources.projects.resources.locations.resources.restorePlans.methods.setTags (Total Keys: 12) - schemas.GetTagsResponse (Total Keys: 5) - schemas.SetTagsRequest (Total Keys: 5) - schemas.SetTagsResponse (Total Keys: 5) --- ...kup_v1.projects.locations.backupPlans.html | 63 +++++++ ...up_v1.projects.locations.restorePlans.html | 63 +++++++ .../documents/gkebackup.v1.json | 174 +++++++++++++++++- 3 files changed, 299 insertions(+), 1 deletion(-) diff --git a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html index bd2bb5ba0f..641c96ac11 100644 --- a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html +++ b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html @@ -94,6 +94,9 @@

Instance Methods

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

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

+

+ getTags(name, x__xgafv=None)

+

Returns tags directly bound to a GCP resource.

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

Lists BackupPlans in a given location.

@@ -106,6 +109,9 @@

Instance Methods

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

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

+

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

+

Updates tags directly bound to a GCP resource.

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

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

@@ -425,6 +431,29 @@

Method Details

}
+
+ getTags(name, x__xgafv=None) +
Returns tags directly bound to a GCP resource.
+
+Args:
+  name: string, Required. The full resource name of the service resource. (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 GetTags.
+  "etag": "A String", # A checksum based on the current bindings. This field is always set in server responses.
+  "name": "A String", # Required. The full resource name of the service resource.
+  "tags": { # Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists BackupPlans in a given location.
@@ -762,6 +791,40 @@ 

Method Details

}
+
+ setTags(name, body=None, x__xgafv=None) +
Updates tags directly bound to a GCP resource.
+
+Args:
+  name: string, Required. The full resource name of the service resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetTags.
+  "etag": "A String", # Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.
+  "requestId": "A String", # Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.
+  "tags": { # Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SetTags.
+  "etag": "A String", # A checksum based on the current bindings. This field is always set in server responses.
+  "name": "A String", # Required. The full resource name of the service resource.
+  "tags": { # Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
diff --git a/docs/dyn/gkebackup_v1.projects.locations.restorePlans.html b/docs/dyn/gkebackup_v1.projects.locations.restorePlans.html
index 371cf59a20..c382545e0d 100644
--- a/docs/dyn/gkebackup_v1.projects.locations.restorePlans.html
+++ b/docs/dyn/gkebackup_v1.projects.locations.restorePlans.html
@@ -94,6 +94,9 @@ 

Instance Methods

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

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

+

+ getTags(name, x__xgafv=None)

+

Returns tags directly bound to a GCP resource.

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

Lists RestorePlans in a given location.

@@ -106,6 +109,9 @@

Instance Methods

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

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

+

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

+

Updates tags directly bound to a GCP resource.

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

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

@@ -492,6 +498,29 @@

Method Details

}
+
+ getTags(name, x__xgafv=None) +
Returns tags directly bound to a GCP resource.
+
+Args:
+  name: string, Required. The full resource name of the service resource. (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 GetTags.
+  "etag": "A String", # A checksum based on the current bindings. This field is always set in server responses.
+  "name": "A String", # Required. The full resource name of the service resource.
+  "tags": { # Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists RestorePlans in a given location.
@@ -895,6 +924,40 @@ 

Method Details

}
+
+ setTags(name, body=None, x__xgafv=None) +
Updates tags directly bound to a GCP resource.
+
+Args:
+  name: string, Required. The full resource name of the service resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetTags.
+  "etag": "A String", # Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.
+  "requestId": "A String", # Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.
+  "tags": { # Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SetTags.
+  "etag": "A String", # A checksum based on the current bindings. This field is always set in server responses.
+  "name": "A String", # Required. The full resource name of the service resource.
+  "tags": { # Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing"
+    "a_key": "A String",
+  },
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json
index f36c41639b..ae0ae04b13 100644
--- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json
@@ -558,6 +558,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getTags": {
+"description": "Returns tags directly bound to a GCP resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:getTags",
+"httpMethod": "GET",
+"id": "gkebackup.projects.locations.backupPlans.getTags",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:getTags",
+"response": {
+"$ref": "GetTagsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Lists BackupPlans in a given location.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans",
@@ -666,6 +691,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setTags": {
+"description": "Updates tags directly bound to a GCP resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:setTags",
+"httpMethod": "POST",
+"id": "gkebackup.projects.locations.backupPlans.setTags",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:setTags",
+"request": {
+"$ref": "SetTagsRequest"
+},
+"response": {
+"$ref": "SetTagsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "testIamPermissions": {
 "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:testIamPermissions",
@@ -1659,6 +1712,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getTags": {
+"description": "Returns tags directly bound to a GCP resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:getTags",
+"httpMethod": "GET",
+"id": "gkebackup.projects.locations.restorePlans.getTags",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:getTags",
+"response": {
+"$ref": "GetTagsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Lists RestorePlans in a given location.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans",
@@ -1767,6 +1845,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setTags": {
+"description": "Updates tags directly bound to a GCP resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:setTags",
+"httpMethod": "POST",
+"id": "gkebackup.projects.locations.restorePlans.setTags",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:setTags",
+"request": {
+"$ref": "SetTagsRequest"
+},
+"response": {
+"$ref": "SetTagsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "testIamPermissions": {
 "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:testIamPermissions",
@@ -2232,7 +2338,7 @@
 }
 }
 },
-"revision": "20251209",
+"revision": "20260107",
 "rootUrl": "https://gkebackup.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -3086,6 +3192,28 @@
 },
 "type": "object"
 },
+"GetTagsResponse": {
+"description": "Response message for GetTags.",
+"id": "GetTagsResponse",
+"properties": {
+"etag": {
+"description": "A checksum based on the current bindings. This field is always set in server responses.",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"type": "string"
+},
+"tags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
+"type": "object"
+}
+},
+"type": "object"
+},
 "GoogleLongrunningCancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "GoogleLongrunningCancelOperationRequest",
@@ -4228,6 +4356,50 @@
 },
 "type": "object"
 },
+"SetTagsRequest": {
+"description": "Request message for SetTags.",
+"id": "SetTagsRequest",
+"properties": {
+"etag": {
+"description": "Optional. A checksum based on the current bindings which can be passed to prevent race conditions. If not passed, etag check would be skipped.",
+"type": "string"
+},
+"requestId": {
+"description": "Optional. A unique identifier for this request. Must be a valid UUID. This request is only idempotent if a `request_id` is provided.",
+"type": "string"
+},
+"tags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Required. These bindings will override any bindings previously set and will be effective immediately. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
+"type": "object"
+}
+},
+"type": "object"
+},
+"SetTagsResponse": {
+"description": "Response message for SetTags.",
+"id": "SetTagsResponse",
+"properties": {
+"etag": {
+"description": "A checksum based on the current bindings. This field is always set in server responses.",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource name of the service resource.",
+"type": "string"
+},
+"tags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Required. Tag keys/values directly bound to this resource. Each item in the map must be expressed as \" : \". For example: \"123/environment\" : \"production\", \"123/costCenter\" : \"marketing\"",
+"type": "object"
+}
+},
+"type": "object"
+},
 "SubstitutionRule": {
 "description": "A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.",
 "id": "SubstitutionRule",

From 1799855204e997055044f5224673c96fae394239 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 20 Jan 2026 07:15:38 +0000
Subject: [PATCH 26/45] fix(gmail): update the api

#### gmail:v1

The following keys were changed:
- resources.users.resources.messages.methods.import.mediaUpload.maxSize (Total Keys: 1)
- resources.users.resources.messages.methods.insert.mediaUpload.maxSize (Total Keys: 1)
---
 googleapiclient/discovery_cache/documents/gmail.v1.json | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json
index 157af8d5da..0334fa71f5 100644
--- a/googleapiclient/discovery_cache/documents/gmail.v1.json
+++ b/googleapiclient/discovery_cache/documents/gmail.v1.json
@@ -953,7 +953,7 @@
 "accept": [
 "message/*"
 ],
-"maxSize": "52428800",
+"maxSize": "157286400",
 "protocols": {
 "resumable": {
 "multipart": true,
@@ -1032,7 +1032,7 @@
 "accept": [
 "message/*"
 ],
-"maxSize": "52428800",
+"maxSize": "157286400",
 "protocols": {
 "resumable": {
 "multipart": true,
@@ -3077,7 +3077,7 @@
 }
 }
 },
-"revision": "20251201",
+"revision": "20260112",
 "rootUrl": "https://gmail.googleapis.com/",
 "schemas": {
 "AutoForwarding": {

From 595fa2b7b670d365cc1e7572cccf23da946346b5 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 20 Jan 2026 07:15:38 +0000
Subject: [PATCH 27/45] feat(managedkafka): update the api

#### managedkafka:v1

The following keys were added:
- resources.projects.resources.locations.resources.clusters.resources.consumerGroups.methods.list.parameters.filter (Total Keys: 2)
---
 ...afka_v1.projects.locations.clusters.consumerGroups.html | 5 +++--
 .../discovery_cache/documents/managedkafka.v1.json         | 7 ++++++-
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/managedkafka_v1.projects.locations.clusters.consumerGroups.html b/docs/dyn/managedkafka_v1.projects.locations.clusters.consumerGroups.html
index c45a91048d..d01c0f5f82 100644
--- a/docs/dyn/managedkafka_v1.projects.locations.clusters.consumerGroups.html
+++ b/docs/dyn/managedkafka_v1.projects.locations.clusters.consumerGroups.html
@@ -84,7 +84,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns the properties of a single consumer group.

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)

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

Lists the consumer groups in a given cluster.

list_next()

@@ -146,11 +146,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the consumer groups in a given cluster.
 
 Args:
   parent: string, Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`. (required)
+  filter: string, Optional. Filter expression for the result. Only supports filtering by topic name as a key in the `topics` map.
   pageSize: integer, Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
   pageToken: string, Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token.
   view: string, Optional. Specifies the view (BASIC or FULL) of the ConsumerGroup resource to be returned in the response. Defaults to FULL view.
diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json
index 06909f154b..b48f62b6a8 100644
--- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json
+++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json
@@ -866,6 +866,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. Filter expression for the result. Only supports filtering by topic name as a key in the `topics` map.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.",
 "format": "int32",
@@ -3181,7 +3186,7 @@
 }
 }
 },
-"revision": "20251212",
+"revision": "20260108",
 "rootUrl": "https://managedkafka.googleapis.com/",
 "schemas": {
 "AccessConfig": {

From 7e48720f41a10ad8f37bf116116241d1b02082be Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 20 Jan 2026 07:15:38 +0000
Subject: [PATCH 28/45] feat(merchantapi): update the api

#### merchantapi:inventories_v1

The following keys were added:
- schemas.InventoryLoyaltyProgram (Total Keys: 10)
- schemas.LocalInventoryAttributes.properties.loyaltyPrograms (Total Keys: 2)
- schemas.RegionalInventoryAttributes.properties.loyaltyPrograms (Total Keys: 2)
---
 ...v1.accounts.products.localInventories.html | 60 +++++++++++++++++++
 ...accounts.products.regionalInventories.html | 60 +++++++++++++++++++
 ...pi_products_v1.accounts.productInputs.html |  8 +--
 ...hantapi_products_v1.accounts.products.html |  4 +-
 ...roducts_v1beta.accounts.productInputs.html |  8 +--
 ...api_products_v1beta.accounts.products.html |  4 +-
 .../documents/merchantapi.inventories_v1.json | 52 +++++++++++++++-
 .../documents/merchantapi.products_v1.json    |  4 +-
 .../merchantapi.products_v1beta.json          |  4 +-
 9 files changed, 187 insertions(+), 17 deletions(-)

diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html
index a87ccd6424..f7b8c1e4d4 100644
--- a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html
+++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html
@@ -127,6 +127,26 @@ 

Method Details

"localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "pickupMethod": "A String", # Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. "pickupSla": "A String", # Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. See more details [here](https://support.google.com/merchants/answer/3061342). "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. @@ -160,6 +180,26 @@

Method Details

"localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "pickupMethod": "A String", # Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. "pickupSla": "A String", # Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. See more details [here](https://support.google.com/merchants/answer/3061342). "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. @@ -204,6 +244,26 @@

Method Details

"localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342). + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "pickupMethod": "A String", # Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. "pickupSla": "A String", # Optional. Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. See more details [here](https://support.google.com/merchants/answer/3061342). "price": { # The price represented as a number and currency. # Optional. Price of the product at this store. diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html index 8b0aab735d..d220faeae7 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html @@ -128,6 +128,26 @@

Method Details

"region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes. "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. Also see [Regional availability and pricing](https://support.google.com/merchants/answer/14644124) and [How to set up regional member pricing](https://support.google.com/merchants/answer/16388178) for more information. + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "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). @@ -157,6 +177,26 @@

Method Details

"region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes. "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. Also see [Regional availability and pricing](https://support.google.com/merchants/answer/14644124) and [How to set up regional member pricing](https://support.google.com/merchants/answer/16388178) for more information. + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "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). @@ -198,6 +238,26 @@

Method Details

"region": "A String", # Required. Immutable. ID of the region for this `RegionalInventory` resource. See the [Regional availability and pricing](https://support.google.com/merchants/answer/9698880) for more details. "regionalInventoryAttributes": { # Regional inventory attributes. # Optional. A list of regional inventory attributes. "availability": "A String", # Optional. [Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. + "loyaltyPrograms": [ # Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. Also see [Regional availability and pricing](https://support.google.com/merchants/answer/14644124) and [How to set up regional member pricing](https://support.google.com/merchants/answer/16388178) for more information. + { # A message that represents loyalty program. + "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. + "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). + }, + "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + }, + "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. + "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). + }, + "programLabel": "A String", # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account. + "shippingLabel": "A String", # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. + "tierLabel": "A String", # The label of the tier within the loyalty program. Must match one of the labels within the program. + }, + ], "price": { # The price represented as a number and currency. # Optional. Price of the product in this region. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index 1a2420dee8..dabf25bd74 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -282,7 +282,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -632,7 +632,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -983,7 +983,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -1334,7 +1334,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 25aa473eb4..ffcf0f6773 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -282,7 +282,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -691,7 +691,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index c8a26b9f6b..38f452d373 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -239,7 +239,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -560,7 +560,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -882,7 +882,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -1204,7 +1204,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index 145c6d708f..b176bd7dfd 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -225,7 +225,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "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). @@ -605,7 +605,7 @@

Method Details

"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. }, "loyaltyPrograms": [ # A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item. - { # LINT.IfChange(LoyaltyProgram) A message that represents loyalty program. + { # A message that represents loyalty program. "cashbackForFutureUse": { # The price represented as a number and currency. # The cashback that can be used for future purchases. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 565ebe2dc4..0403babd7a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -300,7 +300,7 @@ } } }, -"revision": "20251118", +"revision": "20260113", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -326,6 +326,42 @@ }, "type": "object" }, +"InventoryLoyaltyProgram": { +"description": "A message that represents loyalty program.", +"id": "InventoryLoyaltyProgram", +"properties": { +"cashbackForFutureUse": { +"$ref": "Price", +"description": "The cashback that can be used for future purchases." +}, +"loyaltyPoints": { +"description": "The amount of loyalty points earned on a purchase.", +"format": "int64", +"type": "string" +}, +"memberPriceEffectiveInterval": { +"$ref": "Interval", +"description": "A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash." +}, +"price": { +"$ref": "Price", +"description": "The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price." +}, +"programLabel": { +"description": "The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business entity and a loyalty program entity. The label must be provided if there are multiple loyalty programs available for the merchant, so that the system can associate the assets below (for example, price and points) with the correct business. The corresponding program must be linked to the Merchant Center account.", +"type": "string" +}, +"shippingLabel": { +"description": "The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier.", +"type": "string" +}, +"tierLabel": { +"description": "The label of the tier within the loyalty program. Must match one of the labels within the program.", +"type": "string" +} +}, +"type": "object" +}, "ListLocalInventoriesResponse": { "description": "Response message for the `ListLocalInventories` method.", "id": "ListLocalInventoriesResponse", @@ -414,6 +450,13 @@ "description": "Optional. Location of the product inside the store. Maximum length is 20 bytes.", "type": "string" }, +"loyaltyPrograms": { +"description": "Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product at this store. This field is used to show store-specific member prices on Local Inventory Ads (LIA). To use this, the loyalty program must be configured in Google Merchant Center. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. For local inventory specific details, see the [Local inventory data specification](https://support.google.com/merchants/answer/3061342).", +"items": { +"$ref": "InventoryLoyaltyProgram" +}, +"type": "array" +}, "pickupMethod": { "description": "Optional. Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `\"not supported\"`, this field must be submitted together with `pickupSla`.", "enum": [ @@ -690,6 +733,13 @@ false ], "type": "string" }, +"loyaltyPrograms": { +"description": "Optional. An optional list of loyalty programs containing applicable loyalty member prices for this product in this region. This field is used to show region-specific member prices on Product Listing Ads (PLA). To use this, the loyalty program must be configured in Google Merchant Center, and the merchant must be using the Regional Availability and Pricing (RAAP) feature. The benefits provided must match the merchant's website and be clear to members. This is only applicable for merchants in supported countries. See [Loyalty program](https://support.google.com/merchants/answer/12922446) for details on supported countries and loyalty program configuration. Also see [Regional availability and pricing](https://support.google.com/merchants/answer/14644124) and [How to set up regional member pricing](https://support.google.com/merchants/answer/16388178) for more information.", +"items": { +"$ref": "InventoryLoyaltyProgram" +}, +"type": "array" +}, "price": { "$ref": "Price", "description": "Optional. Price of the product in this region." diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index 507d197194..822fe7874f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20251207", +"revision": "20260113", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -970,7 +970,7 @@ false "type": "object" }, "LoyaltyProgram": { -"description": "LINT.IfChange(LoyaltyProgram) A message that represents loyalty program.", +"description": "A message that represents loyalty program.", "id": "LoyaltyProgram", "properties": { "cashbackForFutureUse": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index 202b59654d..74df746421 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -281,7 +281,7 @@ } } }, -"revision": "20251207", +"revision": "20260113", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1179,7 +1179,7 @@ false "type": "object" }, "LoyaltyProgram": { -"description": "LINT.IfChange(LoyaltyProgram) A message that represents loyalty program.", +"description": "A message that represents loyalty program.", "id": "LoyaltyProgram", "properties": { "cashbackForFutureUse": { From 2a94574dee4e0b17b308cb1498fd52e25c7d81ef Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 29/45] feat(monitoring): update the api #### monitoring:v1 The following keys were added: - schemas.FilterControl (Total Keys: 3) - schemas.Widget.properties.filterControl.$ref (Total Keys: 1) --- .../monitoring_v1.projects.dashboards.html | 72 +++++++++++++++++++ .../documents/monitoring.v1.json | 17 ++++- 2 files changed, 88 insertions(+), 1 deletion(-) diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index b2356bcf5f..b2e2e2171a 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -152,6 +152,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -1018,6 +1021,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -1780,6 +1786,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -2544,6 +2553,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -3333,6 +3345,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -4199,6 +4214,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -4961,6 +4979,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -5725,6 +5746,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -6538,6 +6562,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -7404,6 +7431,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -8166,6 +8196,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -8930,6 +8963,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -9729,6 +9765,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -10595,6 +10634,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -11357,6 +11399,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -12121,6 +12166,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -12928,6 +12976,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -13794,6 +13845,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -14556,6 +14610,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -15320,6 +15377,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -16109,6 +16169,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -16975,6 +17038,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -17737,6 +17803,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. @@ -18501,6 +18570,9 @@

Method Details

"A String", ], }, + "filterControl": { # A widget that displays an input field to change the value of a template variable. # A widget that displays an input field to change the value of a template variable. + "templateVariable": "A String", # Name of the template variable the widget affects. + }, "id": "A String", # Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional. "incidentList": { # A widget that displays a list of incidents # A widget that shows list of incidents. "monitoredResources": [ # Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 83a893273b..8032e42fe6 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20250821", +"revision": "20260108", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1601,6 +1601,17 @@ }, "type": "object" }, +"FilterControl": { +"description": "A widget that displays an input field to change the value of a template variable.", +"id": "FilterControl", +"properties": { +"templateVariable": { +"description": "Name of the template variable the widget affects.", +"type": "string" +} +}, +"type": "object" +}, "GaugeView": { "description": "A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).", "id": "GaugeView", @@ -2999,6 +3010,10 @@ "$ref": "ErrorReportingPanel", "description": "A widget that displays a list of error groups." }, +"filterControl": { +"$ref": "FilterControl", +"description": "A widget that displays an input field to change the value of a template variable." +}, "id": { "description": "Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional.", "type": "string" From 80c1765113e13bbea9ad7c05b7e8949677da7a5e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:38 +0000 Subject: [PATCH 30/45] feat(netapp): update the api #### netapp:v1 The following keys were added: - resources.projects.resources.locations.resources.volumes.methods.establishPeering (Total Keys: 12) - schemas.EstablishVolumePeeringRequest (Total Keys: 7) --- ...pp_v1.projects.locations.backupVaults.html | 24 +++--- ...tapp_v1.projects.locations.kmsConfigs.html | 26 +++--- .../netapp_v1.projects.locations.volumes.html | 74 +++++++++++++--- ...beta1.projects.locations.backupVaults.html | 24 +++--- ...v1beta1.projects.locations.kmsConfigs.html | 26 +++--- ...pp_v1beta1.projects.locations.volumes.html | 24 +++--- .../discovery_cache/documents/netapp.v1.json | 84 ++++++++++++++++--- .../documents/netapp.v1beta1.json | 30 ++++--- 8 files changed, 214 insertions(+), 98 deletions(-) diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.html index 0cd0c958ce..78410c2032 100644 --- a/docs/dyn/netapp_v1.projects.locations.backupVaults.html +++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.html @@ -117,7 +117,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -125,12 +125,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -221,7 +221,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -229,12 +229,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -267,7 +267,7 @@

Method Details

"backupVaults": [ # A list of backupVaults in the project for the specified location. { # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -275,12 +275,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -322,7 +322,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -330,12 +330,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, diff --git a/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html b/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html index 7229b0cc35..8aabb726eb 100644 --- a/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html +++ b/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html @@ -116,15 +116,15 @@

Method Details

body: object, The request body. The object takes the form of: -{ # KmsConfig is the customer managed encryption key(CMEK) configuration. +{ # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -250,15 +250,15 @@

Method Details

Returns: An object of the form: - { # KmsConfig is the customer managed encryption key(CMEK) configuration. + { # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -285,15 +285,15 @@

Method Details

{ # ListKmsConfigsResponse is the response to a ListKmsConfigsRequest. "kmsConfigs": [ # The list of KmsConfigs - { # KmsConfig is the customer managed encryption key(CMEK) configuration. + { # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -325,19 +325,19 @@

Method Details

Updates the Kms config properties with the full spec
 
 Args:
-  name: string, Identifier. Name of the KmsConfig. (required)
+  name: string, Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+{ # KmsConfig is the customer-managed encryption key(CMEK) configuration.
   "createTime": "A String", # Output only. Create time of the KmsConfig.
-  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+  "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
   "description": "A String", # Description of the KmsConfig.
   "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
   "labels": { # Labels as key value pairs
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. Name of the KmsConfig.
+  "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`
   "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
   "state": "A String", # Output only. State of the KmsConfig.
   "stateDetails": "A String", # Output only. State details of the KmsConfig.
diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html
index b0012460c8..e2cbb176f1 100644
--- a/docs/dyn/netapp_v1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1.projects.locations.volumes.html
@@ -98,6 +98,9 @@ 

Instance Methods

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

Deletes a single Volume.

+

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

+

Establish volume peering. This is used to establish cluster and svm peerings between the GCNV and OnPrem clusters.

get(name, x__xgafv=None)

Gets details of a single Volume.

@@ -147,7 +150,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -161,7 +164,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -190,7 +193,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -366,6 +369,53 @@

Method Details

}
+
+ establishPeering(name, body=None, x__xgafv=None) +
Establish volume peering. This is used to establish cluster and svm peerings between the GCNV and OnPrem clusters.
+
+Args:
+  name: string, Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EstablishVolumePeeringRequest establishes cluster and svm peerings between the source and destination clusters.
+  "peerClusterName": "A String", # Required. Name of the user's local source cluster to be peered with the destination cluster.
+  "peerIpAddresses": [ # Optional. List of IPv4 ip addresses to be used for peering.
+    "A String",
+  ],
+  "peerSvmName": "A String", # Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.
+  "peerVolumeName": "A String", # Required. Name of the user's local source volume to be peered with the destination volume.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None)
Gets details of a single Volume.
@@ -396,7 +446,7 @@ 

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -410,7 +460,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -439,7 +489,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -590,7 +640,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -604,7 +654,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -633,7 +683,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -785,7 +835,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -799,7 +849,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -828,7 +878,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. diff --git a/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html index d34712bcd5..1d0c247730 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.backupVaults.html @@ -117,7 +117,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -125,12 +125,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -221,7 +221,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -229,12 +229,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -267,7 +267,7 @@

Method Details

"backupVaults": [ # A list of backupVaults in the project for the specified location. { # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -275,12 +275,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, @@ -322,7 +322,7 @@

Method Details

{ # A NetApp BackupVault. "backupRegion": "A String", # Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}` - "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retenton of backups. + "backupRetentionPolicy": { # Retention policy for backups in the backup vault # Optional. Backup retention policy defining the retention of backups. "backupMinimumEnforcedRetentionDays": 42, # Required. Minimum retention duration in days for backups in the backup vault. "dailyBackupImmutable": True or False, # Optional. Indicates if the daily backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. "manualBackupImmutable": True or False, # Optional. Indicates if the manual backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. @@ -330,12 +330,12 @@

Method Details

"weeklyBackupImmutable": True or False, # Optional. Indicates if the weekly backups are immutable. At least one of daily_backup_immutable, weekly_backup_immutable, monthly_backup_immutable and manual_backup_immutable must be true. }, "backupVaultType": "A String", # Optional. Type of backup vault to be created. Default is IN_REGION. - "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version} + "backupsCryptoKeyVersion": "A String", # Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}` "createTime": "A String", # Output only. Create time of the backup vault. "description": "A String", # Description of the backup vault. "destinationBackupVault": "A String", # Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}` "encryptionState": "A String", # Output only. Field indicating encryption state of CMEK backups. - "kmsConfig": "A String", # Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config} + "kmsConfig": "A String", # Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", }, diff --git a/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html b/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html index a1e572c93a..9174046e56 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html @@ -116,15 +116,15 @@

Method Details

body: object, The request body. The object takes the form of: -{ # KmsConfig is the customer managed encryption key(CMEK) configuration. +{ # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -250,15 +250,15 @@

Method Details

Returns: An object of the form: - { # KmsConfig is the customer managed encryption key(CMEK) configuration. + { # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -285,15 +285,15 @@

Method Details

{ # ListKmsConfigsResponse is the response to a ListKmsConfigsRequest. "kmsConfigs": [ # The list of KmsConfigs - { # KmsConfig is the customer managed encryption key(CMEK) configuration. + { # KmsConfig is the customer-managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. Name of the KmsConfig. + "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key. "state": "A String", # Output only. State of the KmsConfig. "stateDetails": "A String", # Output only. State details of the KmsConfig. @@ -325,19 +325,19 @@

Method Details

Updates the Kms config properties with the full spec
 
 Args:
-  name: string, Identifier. Name of the KmsConfig. (required)
+  name: string, Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # KmsConfig is the customer managed encryption key(CMEK) configuration.
+{ # KmsConfig is the customer-managed encryption key(CMEK) configuration.
   "createTime": "A String", # Output only. Create time of the KmsConfig.
-  "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+  "cryptoKeyName": "A String", # Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
   "description": "A String", # Description of the KmsConfig.
   "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key.
   "labels": { # Labels as key value pairs
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. Name of the KmsConfig.
+  "name": "A String", # Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`
   "serviceAccount": "A String", # Output only. The Service account which will have access to the customer provided encryption key.
   "state": "A String", # Output only. State of the KmsConfig.
   "stateDetails": "A String", # Output only. State details of the KmsConfig.
diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
index c1bd50eb62..b6ec6c312f 100644
--- a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
@@ -150,7 +150,7 @@ 

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -164,7 +164,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -193,7 +193,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -446,7 +446,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -460,7 +460,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -489,7 +489,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -640,7 +640,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -654,7 +654,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -683,7 +683,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. @@ -835,7 +835,7 @@

Method Details

"A String", ], "identifier": "A String", # Output only. Device identifier of the block volume. This represents `lun_serial_number` for iSCSI volumes. - "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. + "name": "A String", # Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: "-", "_", "}", "{", ".". * Spaces are not allowed. "osType": "A String", # Required. Immutable. The OS type of the volume. This field can't be changed after the block device is created. "sizeGib": "A String", # Optional. The size of the block device in GiB. Any value provided for the `size_gib` field during volume creation is ignored. The block device's size is system-managed and will be set to match the parent Volume's `capacity_gib`. }, @@ -849,7 +849,7 @@

Method Details

"pathList": [ # Optional. List of directory-paths to be pre-populated for the FlexCache volume. "A String", ], - "recursion": True or False, # Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated. + "recursion": True or False, # Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated. }, "cachePrePopulateState": "A String", # Output only. State of the prepopulation job indicating how the prepopulation is progressing. "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume. @@ -878,7 +878,7 @@

Method Details

{ # An export policy rule describing various export options. "accessType": "A String", # Access type (ReadWrite, ReadOnly, None) "allowedClients": "A String", # Comma separated list of allowed clients IP addresses - "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. + "anonUid": "A String", # Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`. "hasRootAccess": "A String", # Whether Unix root access will be granted. "kerberos5ReadOnly": True or False, # If enabled (true) the rule defines a read only access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. "kerberos5ReadWrite": True or False, # If enabled (true) the rule defines read and write access for clients matching the 'allowedClients' specification. It enables nfs clients to mount using 'authentication' kerberos security mode. The 'kerberos5ReadOnly' value be ignored if this is enabled. diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 5f3d9439a4..72ae7e15f7 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -1406,7 +1406,7 @@ ], "parameters": { "name": { -"description": "Identifier. Name of the KmsConfig.", +"description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, @@ -1876,6 +1876,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"establishPeering": { +"description": "Establish volume peering. This is used to establish cluster and svm peerings between the GCNV and OnPrem clusters.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:establishPeering", +"httpMethod": "POST", +"id": "netapp.projects.locations.volumes.establishPeering", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:establishPeering", +"request": { +"$ref": "EstablishVolumePeeringRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single Volume.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}", @@ -2687,7 +2715,7 @@ } } }, -"revision": "20260106", +"revision": "20260111", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3073,7 +3101,7 @@ }, "backupRetentionPolicy": { "$ref": "BackupRetentionPolicy", -"description": "Optional. Backup retention policy defining the retenton of backups." +"description": "Optional. Backup retention policy defining the retention of backups." }, "backupVaultType": { "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", @@ -3090,7 +3118,7 @@ "type": "string" }, "backupsCryptoKeyVersion": { -"description": "Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}", +"description": "Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`", "readOnly": true, "type": "string" }, @@ -3129,7 +3157,7 @@ "type": "string" }, "kmsConfig": { -"description": "Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config}", +"description": "Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "labels": { @@ -3194,7 +3222,7 @@ "type": "string" }, "name": { -"description": "Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: \"-\", \"_\", \"}\", \"{\", \".\". * Spaces are not allowed.", +"description": "Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: \"-\", \"_\", \"}\", \"{\", \".\". * Spaces are not allowed.", "type": "string" }, "osType": { @@ -3351,7 +3379,7 @@ "type": "array" }, "recursion": { -"description": "Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated.", +"description": "Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated.", "type": "boolean" } }, @@ -3444,6 +3472,32 @@ }, "type": "object" }, +"EstablishVolumePeeringRequest": { +"description": "EstablishVolumePeeringRequest establishes cluster and svm peerings between the source and destination clusters.", +"id": "EstablishVolumePeeringRequest", +"properties": { +"peerClusterName": { +"description": "Required. Name of the user's local source cluster to be peered with the destination cluster.", +"type": "string" +}, +"peerIpAddresses": { +"description": "Optional. List of IPv4 ip addresses to be used for peering.", +"items": { +"type": "string" +}, +"type": "array" +}, +"peerSvmName": { +"description": "Required. Name of the user's local source vserver svm to be peered with the destination vserver svm.", +"type": "string" +}, +"peerVolumeName": { +"description": "Required. Name of the user's local source volume to be peered with the destination volume.", +"type": "string" +} +}, +"type": "object" +}, "ExportPolicy": { "description": "Defines the export policy for the volume.", "id": "ExportPolicy", @@ -3693,7 +3747,7 @@ "type": "object" }, "KmsConfig": { -"description": "KmsConfig is the customer managed encryption key(CMEK) configuration.", +"description": "KmsConfig is the customer-managed encryption key(CMEK) configuration.", "id": "KmsConfig", "properties": { "createTime": { @@ -3703,7 +3757,7 @@ "type": "string" }, "cryptoKeyName": { -"description": "Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", +"description": "Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`", "type": "string" }, "description": { @@ -3723,7 +3777,7 @@ "type": "object" }, "name": { -"description": "Identifier. Name of the KmsConfig.", +"description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "serviceAccount": { @@ -4671,7 +4725,7 @@ "type": "string" }, "anonUid": { -"description": "Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`.", +"description": "Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`.", "format": "int64", "type": "string" }, @@ -5056,11 +5110,17 @@ "UNIFIED", "UNIFIED_LARGE_CAPACITY" ], +"enumDeprecated": [ +false, +false, +false, +true +], "enumDescriptions": [ "Storage pool type is not specified.", "Storage pool type is file.", "Storage pool type is unified.", -"Storage pool type is unified large capacity." +"Deprecated: UNIFIED_LARGE_CAPACITY was previously tag 3." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 2fbe645432..f1b2dd3afb 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -1406,7 +1406,7 @@ ], "parameters": { "name": { -"description": "Identifier. Name of the KmsConfig.", +"description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/kmsConfigs/[^/]+$", "required": true, @@ -2715,7 +2715,7 @@ } } }, -"revision": "20260106", +"revision": "20260111", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3101,7 +3101,7 @@ }, "backupRetentionPolicy": { "$ref": "BackupRetentionPolicy", -"description": "Optional. Backup retention policy defining the retenton of backups." +"description": "Optional. Backup retention policy defining the retention of backups." }, "backupVaultType": { "description": "Optional. Type of backup vault to be created. Default is IN_REGION.", @@ -3118,7 +3118,7 @@ "type": "string" }, "backupsCryptoKeyVersion": { -"description": "Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}", +"description": "Output only. The crypto key version used to encrypt the backup vault. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`", "readOnly": true, "type": "string" }, @@ -3157,7 +3157,7 @@ "type": "string" }, "kmsConfig": { -"description": "Optional. Specifies the KMS config to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config}", +"description": "Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "labels": { @@ -3222,7 +3222,7 @@ "type": "string" }, "name": { -"description": "Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be autogenerated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: \"-\", \"_\", \"}\", \"{\", \".\". * Spaces are not allowed.", +"description": "Optional. User-defined name for the block device, unique within the volume. In case no user input is provided, name will be auto-generated in the backend. The name must meet the following requirements: * Be between 1 and 255 characters long. * Contain only uppercase or lowercase letters (A-Z, a-z), numbers (0-9), and the following special characters: \"-\", \"_\", \"}\", \"{\", \".\". * Spaces are not allowed.", "type": "string" }, "osType": { @@ -3379,7 +3379,7 @@ "type": "array" }, "recursion": { -"description": "Optional. Flag indicating whether the directories listed with the pathList need to be recursively pre-populated.", +"description": "Optional. Flag indicating whether the directories listed with the `path_list` need to be recursively pre-populated.", "type": "boolean" } }, @@ -3747,7 +3747,7 @@ "type": "object" }, "KmsConfig": { -"description": "KmsConfig is the customer managed encryption key(CMEK) configuration.", +"description": "KmsConfig is the customer-managed encryption key(CMEK) configuration.", "id": "KmsConfig", "properties": { "createTime": { @@ -3757,7 +3757,7 @@ "type": "string" }, "cryptoKeyName": { -"description": "Required. Customer managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", +"description": "Required. Customer-managed crypto key resource full name. Format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`", "type": "string" }, "description": { @@ -3777,7 +3777,7 @@ "type": "object" }, "name": { -"description": "Identifier. Name of the KmsConfig.", +"description": "Identifier. Name of the KmsConfig. Format: `projects/{project}/locations/{location}/kmsConfigs/{kms_config}`", "type": "string" }, "serviceAccount": { @@ -4725,7 +4725,7 @@ "type": "string" }, "anonUid": { -"description": "Optional. An integer representing the anonymous user ID. Range is 0 to 4294967295. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`.", +"description": "Optional. An integer representing the anonymous user ID. Range is 0 to `4294967295`. Required when `squash_mode` is `ROOT_SQUASH` or `ALL_SQUASH`.", "format": "int64", "type": "string" }, @@ -5110,11 +5110,17 @@ "UNIFIED", "UNIFIED_LARGE_CAPACITY" ], +"enumDeprecated": [ +false, +false, +false, +true +], "enumDescriptions": [ "Storage pool type is not specified.", "Storage pool type is file.", "Storage pool type is unified.", -"Storage pool type is unified large capacity." +"Deprecated: UNIFIED_LARGE_CAPACITY was previously tag 3." ], "type": "string" }, From 44897847a3aac03f022293555a6e0c9b710fef30 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 31/45] feat(networkmanagement): update the api #### networkmanagement:v1 The following keys were added: - schemas.GoogleManagedServiceInfo (Total Keys: 6) - schemas.Step.properties.googleManagedService.$ref (Total Keys: 1) #### networkmanagement:v1beta1 The following keys were added: - schemas.GoogleManagedServiceInfo (Total Keys: 6) - schemas.Step.properties.googleManagedService.$ref (Total Keys: 1) --- ...s.locations.global_.connectivityTests.html | 48 +++++++++++++++++++ ...s.locations.global_.connectivityTests.html | 48 +++++++++++++++++++ .../documents/networkmanagement.v1.json | 48 ++++++++++++++++++- .../documents/networkmanagement.v1beta1.json | 48 ++++++++++++++++++- 4 files changed, 190 insertions(+), 2 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 752ed0ec52..1ed66a065d 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -362,6 +362,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -705,6 +711,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -1251,6 +1263,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -1594,6 +1612,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2131,6 +2155,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2474,6 +2504,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2970,6 +3006,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -3313,6 +3355,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 1ec935a84c..cfde05fc50 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -363,6 +363,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -706,6 +712,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -1254,6 +1266,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -1597,6 +1615,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2136,6 +2160,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2479,6 +2509,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -2977,6 +3013,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. @@ -3320,6 +3362,12 @@

Method Details

"networkUri": "A String", # URI of the network containing the GKE Pod. "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}` }, + "googleManagedService": { # For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state. # Display information of a Google-managed service. + "ipAddress": "A String", # IP address of the Google-managed service endpoint. + "networkUri": "A String", # URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address. + "serviceType": "A String", # Type of a Google-managed service. + "serviceUri": "A String", # URI of the Google-managed service. + }, "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 "googleServiceType": "A String", # Recognized type of a Google Service. "sourceIp": "A String", # Source IP address. diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index c21a1ffa27..745a579a95 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1233,7 +1233,7 @@ } } }, -"revision": "20251229", +"revision": "20260110", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2652,6 +2652,45 @@ false }, "type": "object" }, +"GoogleManagedServiceInfo": { +"description": "For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state.", +"id": "GoogleManagedServiceInfo", +"properties": { +"ipAddress": { +"description": "IP address of the Google-managed service endpoint.", +"type": "string" +}, +"networkUri": { +"description": "URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address.", +"type": "string" +}, +"serviceType": { +"description": "Type of a Google-managed service.", +"enum": [ +"SERVICE_TYPE_UNSPECIFIED", +"UNSUPPORTED", +"CLOUD_SQL", +"GKE_CLUSTER_CONTROL_PLANE", +"REDIS_CLUSTER", +"REDIS_INSTANCE" +], +"enumDescriptions": [ +"Service type is unspecified.", +"Unsupported Google-managed service.", +"Cloud SQL Instance.", +"GKE Cluster control plane.", +"Redis Cluster.", +"Redis Instance." +], +"type": "string" +}, +"serviceUri": { +"description": "URI of the Google-managed service.", +"type": "string" +} +}, +"type": "object" +}, "GoogleServiceInfo": { "description": "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", "id": "GoogleServiceInfo", @@ -4065,6 +4104,10 @@ false "$ref": "GkePodInfo", "description": "Display information of a Google Kubernetes Engine Pod." }, +"googleManagedService": { +"$ref": "GoogleManagedServiceInfo", +"description": "Display information of a Google-managed service." +}, "googleService": { "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" @@ -4165,6 +4208,7 @@ false "ARRIVE_AT_VPC_CONNECTOR", "DIRECT_VPC_EGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", +"ARRIVE_AT_GOOGLE_MANAGED_SERVICE", "NAT", "SKIP_GKE_POD_IP_MASQUERADING", "PROXY_CONNECTION", @@ -4214,6 +4258,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4249,6 +4294,7 @@ false "Forwarding state: arriving at a VPC connector.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", +"Forwarding state: arriving at a Google-managed service endpoint.", "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: GKE Pod IP masquerading is skipped. The `ip_masquerading_skipped` field is populated with the reason.", "Transition state: original connection is terminated and a new proxied connection is initiated.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index ebec082c1e..3a436f46ed 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20251229", +"revision": "20260110", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2660,6 +2660,45 @@ false }, "type": "object" }, +"GoogleManagedServiceInfo": { +"description": "For display only. Metadata associated with ARRIVE_AT_GOOGLE_MANAGED_SERVICE state.", +"id": "GoogleManagedServiceInfo", +"properties": { +"ipAddress": { +"description": "IP address of the Google-managed service endpoint.", +"type": "string" +}, +"networkUri": { +"description": "URI of the Google-managed service endpoint network, it is empty if the IP address is a public IP address.", +"type": "string" +}, +"serviceType": { +"description": "Type of a Google-managed service.", +"enum": [ +"SERVICE_TYPE_UNSPECIFIED", +"UNSUPPORTED", +"CLOUD_SQL", +"GKE_CLUSTER_CONTROL_PLANE", +"REDIS_CLUSTER", +"REDIS_INSTANCE" +], +"enumDescriptions": [ +"Service type is unspecified.", +"Unsupported Google-managed service.", +"Cloud SQL Instance.", +"GKE Cluster control plane.", +"Redis Cluster.", +"Redis Instance." +], +"type": "string" +}, +"serviceUri": { +"description": "URI of the Google-managed service.", +"type": "string" +} +}, +"type": "object" +}, "GoogleServiceInfo": { "description": "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", "id": "GoogleServiceInfo", @@ -4073,6 +4112,10 @@ false "$ref": "GkePodInfo", "description": "Display information of a Google Kubernetes Engine Pod." }, +"googleManagedService": { +"$ref": "GoogleManagedServiceInfo", +"description": "Display information of a Google-managed service." +}, "googleService": { "$ref": "GoogleServiceInfo", "description": "Display information of a Google service" @@ -4173,6 +4216,7 @@ false "ARRIVE_AT_VPC_CONNECTOR", "DIRECT_VPC_EGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", +"ARRIVE_AT_GOOGLE_MANAGED_SERVICE", "NAT", "SKIP_GKE_POD_IP_MASQUERADING", "PROXY_CONNECTION", @@ -4222,6 +4266,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4257,6 +4302,7 @@ false "Forwarding state: arriving at a VPC connector.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", +"Forwarding state: arriving at a Google-managed service endpoint.", "Transition state: packet header translated. The `nat` field is populated with the translation information.", "Transition state: GKE Pod IP masquerading is skipped. The `ip_masquerading_skipped` field is populated with the reason.", "Transition state: original connection is terminated and a new proxied connection is initiated.", From ca6458dd3bedfdfc0c5f2f0edc451a707a402ccc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 32/45] feat(osconfig): update the api #### osconfig:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 20) - schemas.GoogleCloudOsconfigCommonV1__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1alpha__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1main__OperationMetadata (Total Keys: 18) - schemas.ListOperationsResponse (Total Keys: 7) #### osconfig:v1alpha The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 20) - schemas.GoogleCloudOsconfigCommonV1__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1alpha__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1main__OperationMetadata (Total Keys: 18) - schemas.ListOperationsResponse (Total Keys: 7) #### osconfig:v1beta The following keys were added: - schemas.GoogleCloudOsconfigCommonV1__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1alpha__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1main__OperationMetadata (Total Keys: 18) #### osconfig:v2 The following keys were added: - schemas.GoogleCloudOsconfigCommonV1__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1alpha__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1main__OperationMetadata (Total Keys: 18) #### osconfig:v2beta The following keys were added: - schemas.GoogleCloudOsconfigCommonV1__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1alpha__OperationMetadata (Total Keys: 18) - schemas.GoogleCloudOsconfigCommonV1main__OperationMetadata (Total Keys: 18) --- docs/dyn/osconfig_v1.projects.locations.html | 5 + ...nfig_v1.projects.locations.operations.html | 239 +++++++++++++++ .../osconfig_v1alpha.projects.locations.html | 5 + ...v1alpha.projects.locations.operations.html | 239 +++++++++++++++ .../documents/osconfig.v1.json | 287 +++++++++++++++++- .../documents/osconfig.v1alpha.json | 287 +++++++++++++++++- .../documents/osconfig.v1beta.json | 134 +++++++- .../documents/osconfig.v2.json | 134 +++++++- .../documents/osconfig.v2beta.json | 134 +++++++- 9 files changed, 1459 insertions(+), 5 deletions(-) create mode 100644 docs/dyn/osconfig_v1.projects.locations.operations.html create mode 100644 docs/dyn/osconfig_v1alpha.projects.locations.operations.html diff --git a/docs/dyn/osconfig_v1.projects.locations.html b/docs/dyn/osconfig_v1.projects.locations.html index 1042aafbaa..a93ec3986e 100644 --- a/docs/dyn/osconfig_v1.projects.locations.html +++ b/docs/dyn/osconfig_v1.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the instances Resource.

+

+ operations() +

+

Returns the operations Resource.

+

osPolicyAssignments()

diff --git a/docs/dyn/osconfig_v1.projects.locations.operations.html b/docs/dyn/osconfig_v1.projects.locations.operations.html new file mode 100644 index 0000000000..59fcabbb39 --- /dev/null +++ b/docs/dyn/osconfig_v1.projects.locations.operations.html @@ -0,0 +1,239 @@ + + + +

OS Config API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

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

Instance Methods

Returns the instances Resource.

+

+ operations() +

+

Returns the operations Resource.

+

osPolicyAssignments()

diff --git a/docs/dyn/osconfig_v1alpha.projects.locations.operations.html b/docs/dyn/osconfig_v1alpha.projects.locations.operations.html new file mode 100644 index 0000000000..76e6490de6 --- /dev/null +++ b/docs/dyn/osconfig_v1alpha.projects.locations.operations.html @@ -0,0 +1,239 @@ + + + +

OS Config API . projects . locations . operations

+

Instance Methods

+

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

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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

+

+ get(name, x__xgafv=None)

+

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

+

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

+

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

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index c6b08a33a5..03f782296e 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -420,6 +420,134 @@ } } }, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "osconfig.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "osconfig.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "osconfig.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "osconfig.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "osPolicyAssignments": { "methods": { "create": { @@ -1083,7 +1211,7 @@ } } }, -"revision": "20251117", +"revision": "20260108", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -1440,6 +1568,138 @@ "properties": {}, "type": "object" }, +"GoogleCloudOsconfigCommonV1__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1main__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", @@ -1983,6 +2243,31 @@ }, "type": "object" }, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListPatchDeploymentsResponse": { "description": "A response message for listing patch deployments.", "id": "ListPatchDeploymentsResponse", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 0fa9591ebf..079f54856b 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -430,6 +430,134 @@ } } }, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "osconfig.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "osconfig.projects.locations.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "osconfig.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "osconfig.projects.locations.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "osPolicyAssignments": { "methods": { "create": { @@ -707,7 +835,7 @@ } } }, -"revision": "20250727", +"revision": "20260108", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -907,6 +1035,138 @@ }, "type": "object" }, +"GoogleCloudOsconfigCommonV1__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1main__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", @@ -1578,6 +1838,31 @@ }, "type": "object" }, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListVulnerabilityReportsResponse": { "description": "A response message for listing vulnerability reports for all VM instances in the specified location.", "id": "ListVulnerabilityReportsResponse", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 0c5bf74e95..f76d7fa55c 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, -"revision": "20251117", +"revision": "20260108", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -1075,6 +1075,138 @@ "properties": {}, "type": "object" }, +"GoogleCloudOsconfigCommonV1__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1main__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v2.json b/googleapiclient/discovery_cache/documents/osconfig.v2.json index eaa4423132..0748e1c404 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v2.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v2.json @@ -1072,7 +1072,7 @@ } } }, -"revision": "20251117", +"revision": "20260108", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1104,6 +1104,138 @@ }, "type": "object" }, +"GoogleCloudOsconfigCommonV1__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1main__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/osconfig.v2beta.json b/googleapiclient/discovery_cache/documents/osconfig.v2beta.json index 2aa6f82b08..425e3dfbe8 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v2beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v2beta.json @@ -1072,7 +1072,7 @@ } } }, -"revision": "20251117", +"revision": "20260108", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1104,6 +1104,138 @@ }, "type": "object" }, +"GoogleCloudOsconfigCommonV1__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1alpha__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1alpha__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudOsconfigCommonV1main__OperationMetadata": { +"description": "Represents the metadata of a generic long-running operation.", +"id": "GoogleCloudOsconfigCommonV1main__OperationMetadata", +"properties": { +"apiVersion": { +"description": "Output only. API version used to start the operation.", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"requestedCancellation": { +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"readOnly": true, +"type": "boolean" +}, +"statusMessage": { +"description": "Output only. Human-readable status of the operation, if any.", +"readOnly": true, +"type": "string" +}, +"target": { +"description": "Output only. Server-defined resource path for the target of the operation.", +"readOnly": true, +"type": "string" +}, +"verb": { +"description": "Output only. Name of the verb executed by the operation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata": { "description": "OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.", "id": "GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata", From 7a7d5810a218c91f1c7e5febb2efdac945ec83cb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 33/45] fix(parametermanager): update the api #### parametermanager:v1 The following keys were changed: - endpoints (Total Keys: 1) --- ...nager_v1.projects.locations.parameters.html | 2 +- ...projects.locations.parameters.versions.html | 4 ++-- .../documents/parametermanager.v1.json | 18 ++++++++++++++---- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.html index a6e2478c0a..6e12fc826c 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.html @@ -214,7 +214,7 @@

Method Details

filter: string, Optional. Filtering results orderBy: string, Optional. Hint for how to order the results pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. - pageToken: string, Optional. A token identifying a page of results the server should return. + pageToken: string, Optional. A page token, received from a previous `ListParameters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListParameters` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html index 80c789bb02..993ffe5408 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html @@ -173,7 +173,7 @@

Method Details

name: string, Required. Name of the resource in the format `projects/*/locations/*/parameters/*/versions/*`. (required) view: string, Optional. View of the ParameterVersion. In the default FULL view, all metadata & payload associated with the ParameterVersion will be returned. Allowed values - VIEW_UNSPECIFIED - The default / unset value. The API will default to the FULL view.. + VIEW_UNSPECIFIED - The default / unset value. The API will default to the FULL view. BASIC - Include only the metadata for the resource. FULL - Include metadata & other relevant payload data as well. This is the default view. x__xgafv: string, V1 error format. @@ -205,7 +205,7 @@

Method Details

filter: string, Optional. Filtering results orderBy: string, Optional. Hint for how to order the results pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. - pageToken: string, Optional. A token identifying a page of results the server should return. + pageToken: string, Optional. A page token, received from a previous `ListParameterVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListParameterVersions` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index 2b680236dd..a828a021ee 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -250,6 +250,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.ca.rep.googleapis.com/", +"location": "ca" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.in.rep.googleapis.com/", +"location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -541,7 +551,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. A token identifying a page of results the server should return.", +"description": "Optional. A page token, received from a previous `ListParameters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListParameters` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -696,7 +706,7 @@ "FULL" ], "enumDescriptions": [ -"The default / unset value. The API will default to the FULL view..", +"The default / unset value. The API will default to the FULL view.", "Include only the metadata for the resource.", "Include metadata & other relevant payload data as well. This is the default view." ], @@ -738,7 +748,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. A token identifying a page of results the server should return.", +"description": "Optional. A page token, received from a previous `ListParameterVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListParameterVersions` must match the call that provided the page token.", "location": "query", "type": "string" }, @@ -831,7 +841,7 @@ } } }, -"revision": "20251110", +"revision": "20260107", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { From ec50cc2e3c118f84aee1e7aba91dfe3b4a33539f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 34/45] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - schemas.TenantResource.properties.migratedTenantProject (Total Keys: 2) --- .../serviceconsumermanagement_v1.operations.html | 4 ++-- docs/dyn/serviceconsumermanagement_v1.services.html | 1 + ...consumermanagement_v1.services.tenancyUnits.html | 2 ++ .../documents/serviceconsumermanagement.v1.json | 13 +++++++++---- .../serviceconsumermanagement.v1beta1.json | 4 ++-- 5 files changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/dyn/serviceconsumermanagement_v1.operations.html b/docs/dyn/serviceconsumermanagement_v1.operations.html index eace45234e..84066adcd4 100644 --- a/docs/dyn/serviceconsumermanagement_v1.operations.html +++ b/docs/dyn/serviceconsumermanagement_v1.operations.html @@ -184,7 +184,7 @@

Method Details

filter: string, The standard list filter. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. - returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -216,7 +216,7 @@

Method Details

}, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. "A String", ], }
diff --git a/docs/dyn/serviceconsumermanagement_v1.services.html b/docs/dyn/serviceconsumermanagement_v1.services.html index 0cab5b3c0a..daf735ec71 100644 --- a/docs/dyn/serviceconsumermanagement_v1.services.html +++ b/docs/dyn/serviceconsumermanagement_v1.services.html @@ -121,6 +121,7 @@

Method Details

"service": "A String", # Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. "tenantResources": [ # Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. { # Resource constituting the TenancyUnit. + "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. diff --git a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html index 1a4e5db250..3b5cc1f19d 100644 --- a/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html +++ b/docs/dyn/serviceconsumermanagement_v1.services.tenancyUnits.html @@ -325,6 +325,7 @@

Method Details

"service": "A String", # Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. "tenantResources": [ # Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. { # Resource constituting the TenancyUnit. + "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. @@ -437,6 +438,7 @@

Method Details

"service": "A String", # Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. "tenantResources": [ # Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. { # Resource constituting the TenancyUnit. + "migratedTenantProject": "A String", # Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`. "resource": "A String", # Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'. "status": "A String", # Status of tenant resource. "tag": "A String", # Unique per single tenancy unit. diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9f4eba0c7a..47622eface 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -218,7 +218,7 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"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" } @@ -547,7 +547,7 @@ } } }, -"revision": "20251023", +"revision": "20260109", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1160,7 +1160,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { @@ -1796,7 +1796,7 @@ "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -3032,6 +3032,11 @@ "description": "Resource constituting the TenancyUnit.", "id": "TenantResource", "properties": { +"migratedTenantProject": { +"description": "Output only. The newly created regional resource name of the tenant project that has been migrated from a global service. This field is only set for migrated tenant projects. Format: `services//{collection_id}/{RESOURCE_ID}/locations/{LOCATION}/tenantProjects/{TENANT_ID}`.", +"readOnly": true, +"type": "string" +}, "resource": { "description": "Output only. @OutputOnly Identifier of the tenant resource. For cloud projects, it is in the form 'projects/{number}'. For example 'projects/123456'.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 919e82ded1..dcc05488ce 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -724,7 +724,7 @@ } } }, -"revision": "20251023", +"revision": "20260109", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1271,7 +1271,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { From 0806feec436e8d26f2f6ef69eaf685cca9af1813 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 35/45] feat(servicecontrol): update the api #### servicecontrol:v1 The following keys were added: - schemas.QuotaInfo.properties.quotaExtractionState (Total Keys: 2) --- docs/dyn/servicecontrol_v1.services.html | 1 + .../documents/servicecontrol.v1.json | 17 ++++++++++++++++- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/dyn/servicecontrol_v1.services.html b/docs/dyn/servicecontrol_v1.services.html index 3ca63e2ef2..416a7e218a 100644 --- a/docs/dyn/servicecontrol_v1.services.html +++ b/docs/dyn/servicecontrol_v1.services.html @@ -491,6 +491,7 @@

Method Details

"quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the quota check was not successful, then this will not be populated due to no quota consumption. We are not merging this field with 'quota_metrics' field because of the complexity of scaling in Chemist client code base. For simplicity, we will keep this field for Castor (that scales quota usage) and 'quota_metrics' for SuperQuota (that doesn't scale quota usage). "a_key": 42, }, + "quotaExtractionState": "A String", # Output only. Indicates the state of the quota extraction. "quotaMetrics": [ # Quota metrics to indicate the usage. Depending on the check request, one or more of the following metrics will be included: 1. For rate quota, per quota group or per quota metric incremental usage will be specified using the following delta metric: "serviceruntime.googleapis.com/api/consumer/quota_used_count" 2. For allocation quota, per quota metric total usage will be specified using the following gauge metric: "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" 3. For both rate quota and allocation quota, the quota limit reached condition will be specified using the following boolean metric: "serviceruntime.googleapis.com/quota/exceeded" { # Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values. "metricName": "A String", # The metric name defined in the service configuration. diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index b31b7cf52c..f613ec60ac 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, -"revision": "20251125", +"revision": "20251229", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1470,6 +1470,21 @@ "description": "Map of quota group name to the actual number of tokens consumed. If the quota check was not successful, then this will not be populated due to no quota consumption. We are not merging this field with 'quota_metrics' field because of the complexity of scaling in Chemist client code base. For simplicity, we will keep this field for Castor (that scales quota usage) and 'quota_metrics' for SuperQuota (that doesn't scale quota usage). ", "type": "object" }, +"quotaExtractionState": { +"description": "Output only. Indicates the state of the quota extraction.", +"enum": [ +"QUOTA_EXTRACTION_STATE_UNSPECIFIED", +"QUOTA_EXTRACTION_STATE_DARK_LAUNCH", +"QUOTA_EXTRACTION_STATE_TRAFFIC_MIGRATION" +], +"enumDescriptions": [ +"Indicates the quota extraction has not started.", +"Indicates the quota extraction is in dark launch and verifying quota enforcement.", +"Indicates the quota extraction traffic migration is in progress." +], +"readOnly": true, +"type": "string" +}, "quotaMetrics": { "description": "Quota metrics to indicate the usage. Depending on the check request, one or more of the following metrics will be included: 1. For rate quota, per quota group or per quota metric incremental usage will be specified using the following delta metric: \"serviceruntime.googleapis.com/api/consumer/quota_used_count\" 2. For allocation quota, per quota metric total usage will be specified using the following gauge metric: \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\" 3. For both rate quota and allocation quota, the quota limit reached condition will be specified using the following boolean metric: \"serviceruntime.googleapis.com/quota/exceeded\"", "items": { From a11cb958499641580d182ca06ba49bd3ee3ed64f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 36/45] feat(serviceusage): update the api #### serviceusage:v1 The following keys were added: - schemas.GoogleApiServiceusageV2betaMcpEnableRule (Total Keys: 4) - schemas.GoogleApiServiceusageV2betaMcpPolicy (Total Keys: 12) - schemas.GoogleApiServiceusageV2betaMcpService (Total Keys: 3) - schemas.GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata (Total Keys: 2) #### serviceusage:v1beta1 The following keys were added: - schemas.GoogleApiServiceusageV2betaMcpEnableRule (Total Keys: 4) - schemas.GoogleApiServiceusageV2betaMcpPolicy (Total Keys: 12) - schemas.GoogleApiServiceusageV2betaMcpService (Total Keys: 3) - schemas.GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata (Total Keys: 2) --- docs/dyn/serviceusage_v1.operations.html | 4 +- docs/dyn/serviceusage_v1beta1.operations.html | 4 +- .../documents/serviceusage.v1.json | 74 ++++++++++++++++++- .../documents/serviceusage.v1beta1.json | 74 ++++++++++++++++++- 4 files changed, 144 insertions(+), 12 deletions(-) diff --git a/docs/dyn/serviceusage_v1.operations.html b/docs/dyn/serviceusage_v1.operations.html index 70461ea302..b74a9c7209 100644 --- a/docs/dyn/serviceusage_v1.operations.html +++ b/docs/dyn/serviceusage_v1.operations.html @@ -184,7 +184,7 @@

Method Details

name: string, The name of the operation's parent resource. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. - returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -216,7 +216,7 @@

Method Details

}, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. "A String", ], }
diff --git a/docs/dyn/serviceusage_v1beta1.operations.html b/docs/dyn/serviceusage_v1beta1.operations.html index 4d439ae178..ad7b48cba7 100644 --- a/docs/dyn/serviceusage_v1beta1.operations.html +++ b/docs/dyn/serviceusage_v1beta1.operations.html @@ -136,7 +136,7 @@

Method Details

name: string, The name of the operation's parent resource. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. - returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -168,7 +168,7 @@

Method Details

}, }, ], - "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. "A String", ], }
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 599edf2f25..f21aa6ea1a 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -223,7 +223,7 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"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" } @@ -431,7 +431,7 @@ } } }, -"revision": "20251021", +"revision": "20260109", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1275,7 +1275,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { @@ -2397,12 +2397,78 @@ }, "type": "object" }, +"GoogleApiServiceusageV2betaMcpEnableRule": { +"description": "McpEnableRule contains MCP enablement related rules.", +"id": "GoogleApiServiceusageV2betaMcpEnableRule", +"properties": { +"mcpServices": { +"description": "List of enabled MCP services.", +"items": { +"$ref": "GoogleApiServiceusageV2betaMcpService" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2betaMcpPolicy": { +"description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", +"id": "GoogleApiServiceusageV2betaMcpPolicy", +"properties": { +"createTime": { +"description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", +"type": "string" +}, +"mcpEnableRules": { +"description": "McpEnableRules contains MCP enablement related rules.", +"items": { +"$ref": "GoogleApiServiceusageV2betaMcpEnableRule" +}, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2betaMcpService": { +"description": "McpService contains the service names that are enabled for MCP.", +"id": "GoogleApiServiceusageV2betaMcpService", +"properties": { +"service": { +"description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata": { "description": "Metadata for the `UpdateConsumerPolicy` method.", "id": "GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata", "properties": {}, "type": "object" }, +"GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata": { +"description": "Metadata for the `UpdateMcpPolicy` method.", +"id": "GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata", +"properties": {}, +"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", @@ -2652,7 +2718,7 @@ "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index ed9b05fcff..b65cf7e116 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -168,7 +168,7 @@ "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 e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"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" } @@ -969,7 +969,7 @@ } } }, -"revision": "20251021", +"revision": "20260109", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1871,7 +1871,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { @@ -2974,12 +2974,78 @@ }, "type": "object" }, +"GoogleApiServiceusageV2betaMcpEnableRule": { +"description": "McpEnableRule contains MCP enablement related rules.", +"id": "GoogleApiServiceusageV2betaMcpEnableRule", +"properties": { +"mcpServices": { +"description": "List of enabled MCP services.", +"items": { +"$ref": "GoogleApiServiceusageV2betaMcpService" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2betaMcpPolicy": { +"description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", +"id": "GoogleApiServiceusageV2betaMcpPolicy", +"properties": { +"createTime": { +"description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", +"type": "string" +}, +"mcpEnableRules": { +"description": "McpEnableRules contains MCP enablement related rules.", +"items": { +"$ref": "GoogleApiServiceusageV2betaMcpEnableRule" +}, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleApiServiceusageV2betaMcpService": { +"description": "McpService contains the service names that are enabled for MCP.", +"id": "GoogleApiServiceusageV2betaMcpService", +"properties": { +"service": { +"description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata": { "description": "Metadata for the `UpdateConsumerPolicy` method.", "id": "GoogleApiServiceusageV2betaUpdateConsumerPolicyMetadata", "properties": {}, "type": "object" }, +"GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata": { +"description": "Metadata for the `UpdateMcpPolicy` method.", +"id": "GoogleApiServiceusageV2betaUpdateMcpPolicyMetadata", +"properties": {}, +"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", @@ -3347,7 +3413,7 @@ "type": "array" }, "unreachable": { -"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, From 7cc56a17b6434b4afa854eb7932e28715194b40c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 37/45] feat(smartdevicemanagement): update the api #### smartdevicemanagement:v1 The following keys were added: - schemas.GoogleHomeEnterpriseSdmV1Device.properties.ghpName (Total Keys: 2) - schemas.GoogleHomeEnterpriseSdmV1ParentRelation.properties.ghpParent (Total Keys: 2) - schemas.GoogleHomeEnterpriseSdmV1Structure.properties.ghpName (Total Keys: 2) --- ...devicemanagement_v1.enterprises.devices.html | 4 ++++ ...icemanagement_v1.enterprises.structures.html | 2 ++ .../documents/smartdevicemanagement.v1.json | 17 ++++++++++++++++- 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html b/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html index 3e907ae94b..e332c8b81e 100644 --- a/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html +++ b/docs/dyn/smartdevicemanagement_v1.enterprises.devices.html @@ -138,10 +138,12 @@

Method Details

An object of the form: { # Device resource represents an instance of enterprise managed device in the property. + "ghpName": "A String", # Output only. The GHP device ID of the device. "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". "parentRelations": [ # Assignee details of the device. { # Represents device relationships, for instance, structure/room to which the device is assigned to. "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. + "ghpParent": "A String", # Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" }, ], @@ -170,10 +172,12 @@

Method Details

{ # Response message for SmartDeviceManagementService.ListDevices "devices": [ # The list of devices. { # Device resource represents an instance of enterprise managed device in the property. + "ghpName": "A String", # Output only. The GHP device ID of the device. "name": "A String", # Required. The resource name of the device. For example: "enterprises/XYZ/devices/123". "parentRelations": [ # Assignee details of the device. { # Represents device relationships, for instance, structure/room to which the device is assigned to. "displayName": "A String", # Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. + "ghpParent": "A String", # Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: "homegraph.googleapis.com/Structure/ABC" or "homegraph.googleapis.com/Room/ABC" "parent": "A String", # Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123" }, ], diff --git a/docs/dyn/smartdevicemanagement_v1.enterprises.structures.html b/docs/dyn/smartdevicemanagement_v1.enterprises.structures.html index 042140af38..696c857d27 100644 --- a/docs/dyn/smartdevicemanagement_v1.enterprises.structures.html +++ b/docs/dyn/smartdevicemanagement_v1.enterprises.structures.html @@ -109,6 +109,7 @@

Method Details

An object of the form: { # Structure resource represents an instance of enterprise managed home or hotel room. + "ghpName": "A String", # Output only. The unique identifier for the structure in Google Home Platform. Format: homegraph.googleapis.com/Structure/{structure_id} "name": "A String", # Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC". "traits": { # Structure traits. "a_key": "", # Properties of the object. @@ -134,6 +135,7 @@

Method Details

{ # Response message for SmartDeviceManagementService.ListStructures "structures": [ # The list of structures. { # Structure resource represents an instance of enterprise managed home or hotel room. + "ghpName": "A String", # Output only. The unique identifier for the structure in Google Home Platform. Format: homegraph.googleapis.com/Structure/{structure_id} "name": "A String", # Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC". "traits": { # Structure traits. "a_key": "", # Properties of the object. diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index 81782e2ee2..8b3ce9b9df 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -312,13 +312,18 @@ } } }, -"revision": "20240616", +"revision": "20260112", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { "description": "Device resource represents an instance of enterprise managed device in the property.", "id": "GoogleHomeEnterpriseSdmV1Device", "properties": { +"ghpName": { +"description": "Output only. The GHP device ID of the device.", +"readOnly": true, +"type": "string" +}, "name": { "description": "Required. The resource name of the device. For example: \"enterprises/XYZ/devices/123\".", "type": "string" @@ -432,6 +437,11 @@ "readOnly": true, "type": "string" }, +"ghpParent": { +"description": "Output only. The GHP name of the relation -- e.g., structure/room where the device is assigned to. For example: \"homegraph.googleapis.com/Structure/ABC\" or \"homegraph.googleapis.com/Room/ABC\"", +"readOnly": true, +"type": "string" +}, "parent": { "description": "Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: \"enterprises/XYZ/structures/ABC\" or \"enterprises/XYZ/structures/ABC/rooms/123\"", "readOnly": true, @@ -464,6 +474,11 @@ "description": "Structure resource represents an instance of enterprise managed home or hotel room.", "id": "GoogleHomeEnterpriseSdmV1Structure", "properties": { +"ghpName": { +"description": "Output only. The unique identifier for the structure in Google Home Platform. Format: homegraph.googleapis.com/Structure/{structure_id}", +"readOnly": true, +"type": "string" +}, "name": { "description": "Output only. The resource name of the structure. For example: \"enterprises/XYZ/structures/ABC\".", "readOnly": true, From cd1e6dbca8d48ad32fc81419ab1bdc81acb3cdea Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 38/45] feat(sqladmin): update the api #### sqladmin:v1 The following keys were added: - schemas.DnsNameMapping.properties.name.readOnly (Total Keys: 1) - schemas.DnsNameMapping.properties.recordManager (Total Keys: 2) - schemas.ExecuteSqlPayload.properties.application.type (Total Keys: 1) - schemas.InsightsConfig.properties.enhancedQueryInsightsEnabled.type (Total Keys: 1) #### sqladmin:v1beta4 The following keys were added: - schemas.DnsNameMapping.properties.name.readOnly (Total Keys: 1) - schemas.DnsNameMapping.properties.recordManager (Total Keys: 2) - schemas.ExecuteSqlPayload.properties.application.type (Total Keys: 1) - schemas.InsightsConfig.properties.enhancedQueryInsightsEnabled.type (Total Keys: 1) --- docs/dyn/sqladmin_v1.Backups.html | 28 ++++++--- docs/dyn/sqladmin_v1.connect.html | 6 +- docs/dyn/sqladmin_v1.instances.html | 43 ++++++++++---- docs/dyn/sqladmin_v1beta4.backups.html | 28 ++++++--- docs/dyn/sqladmin_v1beta4.connect.html | 6 +- docs/dyn/sqladmin_v1beta4.instances.html | 43 ++++++++++---- .../documents/sqladmin.v1.json | 56 ++++++++++++++++-- .../documents/sqladmin.v1beta4.json | 58 ++++++++++++++++--- 8 files changed, 211 insertions(+), 57 deletions(-) diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html index 4bb1d04278..063627ddfc 100644 --- a/docs/dyn/sqladmin_v1.Backups.html +++ b/docs/dyn/sqladmin_v1.Backups.html @@ -145,7 +145,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -185,7 +186,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -373,6 +375,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -887,7 +890,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -927,7 +931,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1115,6 +1120,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -1315,7 +1321,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -1355,7 +1362,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1543,6 +1551,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -1757,7 +1766,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -1797,7 +1807,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1985,6 +1996,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. diff --git a/docs/dyn/sqladmin_v1.connect.html b/docs/dyn/sqladmin_v1.connect.html index 60868e7d75..b0ade2e57a 100644 --- a/docs/dyn/sqladmin_v1.connect.html +++ b/docs/dyn/sqladmin_v1.connect.html @@ -156,7 +156,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "ipAddresses": [ # The assigned IP addresses for the instance. @@ -178,7 +179,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "ipAddresses": [ # Output only. Mappings containing IP addresses that can be used to connect to the read pool node. diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 3c5495550e..b6537fb2c5 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -1872,6 +1872,7 @@

Method Details

The object takes the form of: { # The request payload used to execute SQL statements. + "application": "A String", # Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters. "autoIamAuthn": True or False, # Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. "database": "A String", # Optional. Name of the database on which the statement will be executed. "partialResultMode": "A String", # Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error. @@ -2369,7 +2370,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -2409,7 +2411,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -2597,6 +2600,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -2971,7 +2975,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -3011,7 +3016,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -3199,6 +3205,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -3524,7 +3531,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -3564,7 +3572,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -3752,6 +3761,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -3971,7 +3981,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -4011,7 +4022,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -4199,6 +4211,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -5578,7 +5591,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -5618,7 +5632,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -5806,6 +5821,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -6964,7 +6980,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -7004,7 +7021,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -7192,6 +7210,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html index bcf11c94f5..c468798a4f 100644 --- a/docs/dyn/sqladmin_v1beta4.backups.html +++ b/docs/dyn/sqladmin_v1beta4.backups.html @@ -150,7 +150,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -190,7 +191,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -378,6 +380,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -892,7 +895,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -932,7 +936,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1120,6 +1125,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -1320,7 +1326,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -1360,7 +1367,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1548,6 +1556,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -1762,7 +1771,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -1802,7 +1812,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -1990,6 +2001,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html index e9dceced41..5fda26150f 100644 --- a/docs/dyn/sqladmin_v1beta4.connect.html +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -156,7 +156,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "ipAddresses": [ # The assigned IP addresses for the instance. @@ -178,7 +179,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "ipAddresses": [ # Output only. Mappings containing IP addresses that can be used to connect to the read pool node. diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 6a26beda37..618a5fea88 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -1872,6 +1872,7 @@

Method Details

The object takes the form of: { # The request payload used to execute SQL statements. + "application": "A String", # Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters. "autoIamAuthn": True or False, # Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. "database": "A String", # Optional. Name of the database on which the statement will be executed. "partialResultMode": "A String", # Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error. @@ -2369,7 +2370,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -2409,7 +2411,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -2597,6 +2600,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -2971,7 +2975,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -3011,7 +3016,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -3199,6 +3205,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -3524,7 +3531,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -3564,7 +3572,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -3752,6 +3761,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -3971,7 +3981,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -4011,7 +4022,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -4199,6 +4211,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -5578,7 +5591,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -5618,7 +5632,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -5806,6 +5821,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. @@ -6964,7 +6980,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. @@ -7004,7 +7021,8 @@

Method Details

{ # DNS metadata. "connectionType": "A String", # Output only. The connection type of the DNS name. "dnsScope": "A String", # Output only. The scope that the DNS name applies to. - "name": "A String", # The DNS name. + "name": "A String", # Output only. The DNS name. + "recordManager": "A String", # Output only. The manager for this DNS record. }, ], "gceZone": "A String", # Output only. The zone of the read pool node. @@ -7192,6 +7210,7 @@

Method Details

"retentionDays": 42, # The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). }, "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres. + "enhancedQueryInsightsEnabled": True or False, # Optional. Whether enhanced query insights feature is enabled. "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. Default is 5. "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query lengths greater than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database. diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 45122c372c..bd700fa208 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2790,7 +2790,7 @@ } } }, -"revision": "20251201", +"revision": "20260106", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2965,6 +2965,7 @@ "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3038,6 +3039,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3069,6 +3071,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -3427,6 +3430,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3500,6 +3504,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3531,6 +3536,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -3876,6 +3882,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3949,6 +3956,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3980,6 +3988,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -4281,6 +4290,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -4354,6 +4364,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4385,6 +4396,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -4883,17 +4895,35 @@ false "description": "Output only. The scope that the DNS name applies to.", "enum": [ "DNS_SCOPE_UNSPECIFIED", -"INSTANCE" +"INSTANCE", +"CLUSTER" ], "enumDescriptions": [ -"Unknown DNS scope.", -"Indicates a instance-level DNS name." +"DNS scope not set. This value should not be used.", +"Indicates an instance-level DNS name.", +"Indicates a cluster-level DNS name." ], "readOnly": true, "type": "string" }, "name": { -"description": "The DNS name.", +"description": "Output only. The DNS name.", +"readOnly": true, +"type": "string" +}, +"recordManager": { +"description": "Output only. The manager for this DNS record.", +"enum": [ +"RECORD_MANAGER_UNSPECIFIED", +"CUSTOMER", +"CLOUD_SQL_AUTOMATION" +], +"enumDescriptions": [ +"Record manager not set. This value should not be used.", +"The record may be managed by the customer. It is not automatically managed by Cloud SQL automation.", +"The record is managed by Cloud SQL, which will create, update, and delete the DNS records for the zone automatically when the Cloud SQL database instance is created or updated." +], +"readOnly": true, "type": "string" } }, @@ -4909,6 +4939,10 @@ false "description": "The request payload used to execute SQL statements.", "id": "ExecuteSqlPayload", "properties": { +"application": { +"description": "Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.", +"type": "string" +}, "autoIamAuthn": { "description": "Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.", "type": "boolean" @@ -5234,6 +5268,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -5307,6 +5342,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5338,6 +5374,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -5725,6 +5762,10 @@ false "description": "Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.", "id": "InsightsConfig", "properties": { +"enhancedQueryInsightsEnabled": { +"description": "Optional. Whether enhanced query insights feature is enabled.", +"type": "boolean" +}, "queryInsightsEnabled": { "description": "Whether Query Insights feature is enabled.", "type": "boolean" @@ -6612,7 +6653,7 @@ false "Creates a Cloud SQL replica instance.", "Creates a new user in a Cloud SQL instance.", "Deletes a user from a Cloud SQL instance.", -"Updates an existing user in a Cloud SQL instance.", +"Updates an existing user in a Cloud SQL instance. If a user with the specified username doesn't exist, a new user is created.", "Creates a database in the Cloud SQL instance.", "Deletes a database in the Cloud SQL instance.", "Updates a database in the Cloud SQL instance.", @@ -7084,6 +7125,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -7157,6 +7199,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -7188,6 +7231,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 43446b1078..4cb3805b28 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2795,7 +2795,7 @@ } } }, -"revision": "20251201", +"revision": "20260106", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2970,6 +2970,7 @@ "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3043,6 +3044,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3074,6 +3076,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -3432,6 +3435,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3505,6 +3509,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3536,6 +3541,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -3881,6 +3887,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -3954,6 +3961,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3985,6 +3993,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -4286,6 +4295,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -4359,6 +4369,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4390,6 +4401,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -4889,17 +4901,35 @@ false "description": "Output only. The scope that the DNS name applies to.", "enum": [ "DNS_SCOPE_UNSPECIFIED", -"INSTANCE" +"INSTANCE", +"CLUSTER" ], "enumDescriptions": [ -"Unknown DNS scope.", -"Indicates a instance-level DNS name." +"DNS scope not set. This value should not be used.", +"Indicates an instance-level DNS name.", +"Indicates a cluster-level DNS name." ], "readOnly": true, "type": "string" }, "name": { -"description": "The DNS name.", +"description": "Output only. The DNS name.", +"readOnly": true, +"type": "string" +}, +"recordManager": { +"description": "Output only. The manager for this DNS record.", +"enum": [ +"RECORD_MANAGER_UNSPECIFIED", +"CUSTOMER", +"CLOUD_SQL_AUTOMATION" +], +"enumDescriptions": [ +"Record manager not set. This value should not be used.", +"The record may be managed by the customer. It is not automatically managed by Cloud SQL automation.", +"The record is managed by Cloud SQL, which will create, update, and delete the DNS records for the zone automatically when the Cloud SQL database instance is created or updated." +], +"readOnly": true, "type": "string" } }, @@ -4915,6 +4945,10 @@ false "description": "The request payload used to execute SQL statements.", "id": "ExecuteSqlPayload", "properties": { +"application": { +"description": "Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters.", +"type": "string" +}, "autoIamAuthn": { "description": "Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.", "type": "boolean" @@ -4932,7 +4966,7 @@ false ], "enumDescriptions": [ "Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.", -"Throw an error if the result exceeds 10 MB or if a partial result can be retrieved. Don't return the result.", +"Throw an error if the result exceeds 10 MB or if only a partial result can be retrieved. Don't return the result.", "Return a truncated result and set `partial_result` to true if the result exceeds 10 MB or if only a partial result can be retrieved due to error. Don't throw an error." ], "type": "string" @@ -5240,6 +5274,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -5313,6 +5348,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -5344,6 +5380,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", @@ -5731,6 +5768,10 @@ false "description": "Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.", "id": "InsightsConfig", "properties": { +"enhancedQueryInsightsEnabled": { +"description": "Optional. Whether enhanced query insights feature is enabled.", +"type": "boolean" +}, "queryInsightsEnabled": { "description": "Whether Query Insights feature is enabled.", "type": "boolean" @@ -6618,7 +6659,7 @@ false "Creates a Cloud SQL replica instance.", "Creates a new user in a Cloud SQL instance.", "Deletes a user from a Cloud SQL instance.", -"Updates an existing user in a Cloud SQL instance.", +"Updates an existing user in a Cloud SQL instance. If a user with the specified username doesn't exist, a new user is created.", "Creates a database in the Cloud SQL instance.", "Deletes a database in the Cloud SQL instance.", "Updates a database in the Cloud SQL instance.", @@ -7090,6 +7131,7 @@ false "MYSQL_8_0_45", "MYSQL_8_0_46", "MYSQL_8_4", +"MYSQL_9_7", "SQLSERVER_2017_STANDARD", "SQLSERVER_2017_ENTERPRISE", "SQLSERVER_2017_EXPRESS", @@ -7163,6 +7205,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -7194,6 +7237,7 @@ false "The database major version is MySQL 8.0 and the minor version is 45.", "The database major version is MySQL 8.0 and the minor version is 46.", "The database version is MySQL 8.4.", +"The database version is MySQL 9.7.", "The database version is SQL Server 2017 Standard.", "The database version is SQL Server 2017 Enterprise.", "The database version is SQL Server 2017 Express.", From bcfeec74f749845311fc2f78c0bb3d39f1209b0b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 39/45] feat(storage): update the api #### storage:v1 The following keys were added: - schemas.RelocateBucketRequest.properties.destinationKmsKeyName.type (Total Keys: 1) --- docs/dyn/storage_v1.buckets.html | 1 + googleapiclient/discovery_cache/documents/storage.v1.json | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html index 583987d17c..2305822e6f 100644 --- a/docs/dyn/storage_v1.buckets.html +++ b/docs/dyn/storage_v1.buckets.html @@ -1899,6 +1899,7 @@

Method Details

"A String", ], }, + "destinationKmsKeyName": "A String", # Resource name of a Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key. If set, is used to encrypt all objects in the destination bucket. "destinationLocation": "A String", # The new location the bucket will be relocated to. "validateOnly": True or False, # If true, validate the operation, but do not actually relocate the bucket. } diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index e9771a592c..a6ef621eaa 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": "\"39373339343838363630393031393634343537\"", +"etag": "\"38343338383939303739323735363535323137\"", "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" @@ -4549,7 +4549,7 @@ } } }, -"revision": "20251118", +"revision": "20260111", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -6454,6 +6454,10 @@ }, "type": "object" }, +"destinationKmsKeyName": { +"description": "Resource name of a Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key. If set, is used to encrypt all objects in the destination bucket.", +"type": "string" +}, "destinationLocation": { "description": "The new location the bucket will be relocated to.", "type": "string" From cb506d8288319f2d2f28673c7b5b9e7469185b2d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 40/45] feat(storagetransfer): update the api #### storagetransfer:v1 The following keys were added: - schemas.TransferCounters.properties.unrestoredDeepArchiveObjectsSkippedCount (Total Keys: 2) - schemas.TransferCounters.properties.unsupportedS3GlacierObjectsSkippedCount (Total Keys: 2) --- .../documents/storagetransfer.v1.json | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index 857785b138..da38cf78cf 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -637,7 +637,7 @@ } } }, -"revision": "20251128", +"revision": "20260109", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -1706,6 +1706,16 @@ "description": "Objects in the data source that are not transferred because they already exist in the data sink.", "format": "int64", "type": "string" +}, +"unrestoredDeepArchiveObjectsSkippedCount": { +"description": "Number of unrestored deep archive objects skipped.", +"format": "int64", +"type": "string" +}, +"unsupportedS3GlacierObjectsSkippedCount": { +"description": "Number of glacier objects skipped, glacier objects are unsupported by default regardless of the restore status. Allowlist the project to copy glacier objects if needed.", +"format": "int64", +"type": "string" } }, "type": "object" From 2b4bff9c4097f2f7d1c391ddd67f8269dbba795b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:39 +0000 Subject: [PATCH 41/45] feat(walletobjects): update the api #### walletobjects:v1 The following keys were added: - schemas.Blobstore2Info.properties.uploadFragmentListCreationInfo (Total Keys: 2) --- docs/dyn/walletobjects_v1.media.html | 16 ++++++++++++++++ .../documents/walletobjects.v1.json | 7 ++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/dyn/walletobjects_v1.media.html b/docs/dyn/walletobjects_v1.media.html index e7bd302205..408d6b1a4a 100644 --- a/docs/dyn/walletobjects_v1.media.html +++ b/docs/dyn/walletobjects_v1.media.html @@ -116,6 +116,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. @@ -127,6 +128,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -163,6 +165,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -188,6 +191,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -216,6 +220,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -242,6 +247,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -266,6 +272,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -294,6 +301,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -378,6 +386,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. @@ -389,6 +398,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -425,6 +435,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -450,6 +461,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -478,6 +490,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -504,6 +517,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -528,6 +542,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. @@ -556,6 +571,7 @@

Method Details

"downloadExternalReadToken": "A String", # A serialized External Read Token passed from Bigstore -> Scotty for a GCS download. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. + "uploadFragmentListCreationInfo": "A String", # A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index 516cb957d3..577cf61091 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2711,7 +2711,7 @@ } } }, -"revision": "20251202", +"revision": "20260113", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3040,6 +3040,11 @@ true "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", "type": "string" }, +"uploadFragmentListCreationInfo": { +"description": "A serialized Object Fragment List Creation Info passed from Bigstore -> Scotty for a GCS upload. This field must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", +"format": "byte", +"type": "string" +}, "uploadMetadataContainer": { "description": "Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", "format": "byte", From ea0b1dbb9c5e5b398dba0ff4efc9383533f1557c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:40 +0000 Subject: [PATCH 42/45] feat(workstations): update the api #### workstations:v1 The following keys were added: - schemas.GceInstance.properties.instanceMetadata (Total Keys: 2) --- ...orkstationClusters.workstationConfigs.html | 25 +++++++++++++++---- .../documents/workstations.v1.json | 11 ++++++-- 2 files changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 5ddfd5dff4..6c836c2899 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -218,6 +218,9 @@

Method Details

"disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. + "instanceMetadata": { # Optional. Custom metadata to apply to Compute Engine instances. + "a_key": "A String", + }, "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -230,7 +233,7 @@

Method Details

"enableSecureBoot": True or False, # Optional. Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Optional. Whether the instance has the vTPM enabled. }, - "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version. "tags": [ # Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). "A String", ], @@ -449,6 +452,9 @@

Method Details

"disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. + "instanceMetadata": { # Optional. Custom metadata to apply to Compute Engine instances. + "a_key": "A String", + }, "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -461,7 +467,7 @@

Method Details

"enableSecureBoot": True or False, # Optional. Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Optional. Whether the instance has the vTPM enabled. }, - "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version. "tags": [ # Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). "A String", ], @@ -669,6 +675,9 @@

Method Details

"disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. + "instanceMetadata": { # Optional. Custom metadata to apply to Compute Engine instances. + "a_key": "A String", + }, "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -681,7 +690,7 @@

Method Details

"enableSecureBoot": True or False, # Optional. Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Optional. Whether the instance has the vTPM enabled. }, - "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version. "tags": [ # Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). "A String", ], @@ -842,6 +851,9 @@

Method Details

"disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. + "instanceMetadata": { # Optional. Custom metadata to apply to Compute Engine instances. + "a_key": "A String", + }, "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -854,7 +866,7 @@

Method Details

"enableSecureBoot": True or False, # Optional. Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Optional. Whether the instance has the vTPM enabled. }, - "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version. "tags": [ # Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). "A String", ], @@ -1030,6 +1042,9 @@

Method Details

"disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. + "instanceMetadata": { # Optional. Custom metadata to apply to Compute Engine instances. + "a_key": "A String", + }, "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -1042,7 +1057,7 @@

Method Details

"enableSecureBoot": True or False, # Optional. Whether the instance has Secure Boot enabled. "enableVtpm": True or False, # Optional. Whether the instance has the vTPM enabled. }, - "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + "startupScriptUri": "A String", # Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version. "tags": [ # Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). "A String", ], diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 5140b41f0f..c22321534e 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1221,7 +1221,7 @@ } } }, -"revision": "20251202", +"revision": "20260113", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1553,6 +1553,13 @@ "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, +"instanceMetadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Custom metadata to apply to Compute Engine instances.", +"type": "object" +}, "machineType": { "description": "Optional. The type of machine to use for VM instances\u2014for example, `\"e2-standard-4\"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).", "type": "string" @@ -1584,7 +1591,7 @@ "description": "Optional. A set of Compute Engine Shielded instance options." }, "startupScriptUri": { -"description": "Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version.", +"description": "Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version of the host VM, and it is the responsibility of the user to ensure the script stays compatible with the OS version.", "type": "string" }, "tags": { From 5f0df744c17fe58bb3486841a73e9c477be2dab0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:40 +0000 Subject: [PATCH 43/45] feat(youtube): update the api #### youtube:v3 The following keys were deleted: - resources.youtube.resources.v3.resources.videos.methods.batchGetStats (Total Keys: 14) - schemas.BatchGetStatsResponse (Total Keys: 8) - schemas.VideoStat (Total Keys: 33) --- docs/dyn/youtube_v3.youtube.v3.html | 5 - .../discovery_cache/documents/youtube.v3.json | 150 +----------------- 2 files changed, 1 insertion(+), 154 deletions(-) diff --git a/docs/dyn/youtube_v3.youtube.v3.html b/docs/dyn/youtube_v3.youtube.v3.html index dafe4ba790..6ea36da1c7 100644 --- a/docs/dyn/youtube_v3.youtube.v3.html +++ b/docs/dyn/youtube_v3.youtube.v3.html @@ -79,11 +79,6 @@

Instance Methods

Returns the liveChat Resource.

-

- videos() -

-

Returns the videos Resource.

-

close()

Close httplib2 connections.

diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 25ec781940..c8b26fe201 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4166,47 +4166,13 @@ } } } -}, -"videos": { -"methods": { -"batchGetStats": { -"description": "Retrieves a batch of VideoStat resources, possibly filtered.", -"flatPath": "youtube/v3/videos:batchGetStats", -"httpMethod": "GET", -"id": "youtube.youtube.v3.videos.batchGetStats", -"parameterOrder": [], -"parameters": { -"id": { -"description": "Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.", -"location": "query", -"repeated": true, -"type": "string" -}, -"onBehalfOfContentOwner": { -"description": "Optional. **Note:** This parameter is intended exclusively for YouTube content partners. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.", -"location": "query", -"type": "string" -}, -"part": { -"description": "Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.", -"location": "query", -"repeated": true, -"type": "string" -} -}, -"path": "youtube/v3/videos:batchGetStats", -"response": { -"$ref": "BatchGetStatsResponse" -} -} -} } } } } } }, -"revision": "20260105", +"revision": "20260112", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -4681,32 +4647,6 @@ }, "type": "object" }, -"BatchGetStatsResponse": { -"description": "Response for the Videos.stats API. Returns VideoStat information about a batch of videos. VideoStat contains a subset of the information in Video that is relevant to statistics and content details.", -"id": "BatchGetStatsResponse", -"properties": { -"etag": { -"description": "Output only. Etag of this resource.", -"readOnly": true, -"type": "string" -}, -"items": { -"description": "Output only. The videos' stats information.", -"items": { -"$ref": "VideoStat" -}, -"readOnly": true, -"type": "array" -}, -"kind": { -"default": "youtube#batchGetStatsResponse", -"description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#batchGetStatsResponse\".", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "Caption": { "description": "A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.", "id": "Caption", @@ -12128,43 +12068,6 @@ true }, "type": "object" }, -"VideoStat": { -"description": "A *VideoStat* resource represents a YouTube video's stats.", -"id": "VideoStat", -"properties": { -"contentDetails": { -"$ref": "VideoStatsContentDetails", -"description": "Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.", -"readOnly": true -}, -"etag": { -"description": "Output only. Etag of this resource.", -"readOnly": true, -"type": "string" -}, -"id": { -"description": "Output only. The ID that YouTube uses to uniquely identify the video.", -"readOnly": true, -"type": "string" -}, -"kind": { -"description": "Output only. Identifies what kind of resource this is. Value: the fixed string \"youtube#videoStats\".", -"readOnly": true, -"type": "string" -}, -"snippet": { -"$ref": "VideoStatsSnippet", -"description": "Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.", -"readOnly": true -}, -"statistics": { -"$ref": "VideoStatsStatistics", -"description": "Output only. The VideoStatsStatistics object contains statistics about the video.", -"readOnly": true -} -}, -"type": "object" -}, "VideoStatistics": { "description": "Statistics about the video, such as the number of times the video was viewed or liked.", "id": "VideoStatistics", @@ -12198,57 +12101,6 @@ true }, "type": "object" }, -"VideoStatsContentDetails": { -"description": "Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API.", -"id": "VideoStatsContentDetails", -"properties": { -"duration": { -"description": "Output only. The length of the video. The property value is a [`google.protobuf.Duration`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) object.", -"format": "google-duration", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"VideoStatsSnippet": { -"description": "Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API.", -"id": "VideoStatsSnippet", -"properties": { -"publishTime": { -"description": "Output only. The date and time that the video was uploaded. The property value is a [`google.protobuf.Timestamp`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp) object.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"VideoStatsStatistics": { -"description": "Statistics about the video, such as the number of times the video was viewed or liked.", -"id": "VideoStatsStatistics", -"properties": { -"commentCount": { -"description": "Output only. The number of comments for the video.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"likeCount": { -"description": "Output only. The number of users who have indicated that they liked the video by giving it a positive rating.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"viewCount": { -"description": "Output only. The number of times the video has been viewed.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "VideoStatus": { "description": "Basic details about a video category, such as its localized title. Next Id: 19", "id": "VideoStatus", From 0bad042e080fa582850fcd020a2d89f6cd2194ed Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:40 +0000 Subject: [PATCH 44/45] feat(youtubereporting): update the api #### youtubereporting:v1 The following keys were added: - schemas.GdataBlobstore2Info.properties.uploadFragmentListCreationInfo (Total Keys: 2) --- docs/dyn/youtubereporting_v1.media.html | 8 ++++++++ .../discovery_cache/documents/youtubereporting.v1.json | 7 ++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/dyn/youtubereporting_v1.media.html b/docs/dyn/youtubereporting_v1.media.html index a544ee5f58..32684553f5 100644 --- a/docs/dyn/youtubereporting_v1.media.html +++ b/docs/dyn/youtubereporting_v1.media.html @@ -113,6 +113,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "compositeMedia": [ # gdata @@ -124,6 +125,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -160,6 +162,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -185,6 +188,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -213,6 +217,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -239,6 +244,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -263,6 +269,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata @@ -291,6 +298,7 @@

Method Details

"downloadExternalReadToken": "A String", # gdata "downloadReadHandle": "A String", # gdata "readToken": "A String", # gdata + "uploadFragmentListCreationInfo": "A String", # gdata "uploadMetadataContainer": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index da5fc98401..61949d043d 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20251123", +"revision": "20260113", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { @@ -447,6 +447,11 @@ "description": "gdata", "type": "string" }, +"uploadFragmentListCreationInfo": { +"description": "gdata", +"format": "byte", +"type": "string" +}, "uploadMetadataContainer": { "description": "gdata", "format": "byte", From 7191110110b04f12133740f45cec843cdb85cb5d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jan 2026 07:15:40 +0000 Subject: [PATCH 45/45] chore(docs): Add new discovery artifacts and artifacts with minor updates --- .../apikeys_v2.projects.locations.keys.html | 8 +- ...remetalsolution_v2.projects.locations.html | 2 +- docs/dyn/chat_v1.spaces.messages.html | 192 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 288 +-- .../cloudidentity_v1.devices.deviceUsers.html | 4 +- ...didentity_v1beta1.devices.deviceUsers.html | 4 +- ...iplatform_v1alpha1.projects.locations.html | 4 +- docs/dyn/dns_v1.resourceRecordSets.html | 4 +- docs/dyn/dns_v1beta2.resourceRecordSets.html | 4 +- ....projects.locations.publishers.models.html | 16 +- ...er_v1alpha1.projects.locations.assets.html | 28 +- ...rojects.locations.sources.errorFrames.html | 8 +- ...ubscription_v1.partners.subscriptions.html | 4 +- docs/dyn/policytroubleshooter_v3.html | 111 ++ docs/dyn/policytroubleshooter_v3.iam.html | 412 ++++ docs/dyn/policytroubleshooter_v3beta.html | 111 ++ docs/dyn/policytroubleshooter_v3beta.iam.html | 528 +++++ ...idding_v1.bidders.pretargetingConfigs.html | 2 +- .../dyn/run_v1.namespaces.configurations.html | 8 +- .../dyn/run_v1.namespaces.domainmappings.html | 8 +- docs/dyn/run_v1.namespaces.executions.html | 6 +- docs/dyn/run_v1.namespaces.jobs.html | 26 +- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.routes.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 24 +- docs/dyn/run_v1.namespaces.tasks.html | 4 +- docs/dyn/run_v1.namespaces.workerpools.html | 24 +- ..._v1.projects.locations.configurations.html | 8 +- ..._v1.projects.locations.domainmappings.html | 8 +- .../run_v1.projects.locations.revisions.html | 4 +- .../dyn/run_v1.projects.locations.routes.html | 4 +- .../run_v1.projects.locations.services.html | 24 +- ...projects.instances.databases.sessions.html | 16 +- .../discovery_cache/documents/apikeys.v2.json | 5 +- .../documents/baremetalsolution.v2.json | 4 +- .../discovery_cache/documents/chat.v1.json | 6 +- .../documents/cloudidentity.v1.json | 4 +- .../documents/cloudidentity.v1beta1.json | 4 +- .../contactcenteraiplatform.v1alpha1.json | 6 +- .../discovery_cache/documents/dns.v1.json | 6 +- .../documents/dns.v1beta2.json | 6 +- .../documents/firebaseml.v2beta.json | 4 +- .../documents/kmsinventory.v1.json | 20 +- .../documents/migrationcenter.v1alpha1.json | 4 +- .../paymentsresellersubscription.v1.json | 6 +- .../documents/policytroubleshooter.v3.json | 1189 ++++++++++++ .../policytroubleshooter.v3beta.json | 1722 +++++++++++++++++ .../documents/realtimebidding.v1.json | 4 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/spanner.v1.json | 4 +- 50 files changed, 4493 insertions(+), 407 deletions(-) create mode 100644 docs/dyn/policytroubleshooter_v3.html create mode 100644 docs/dyn/policytroubleshooter_v3.iam.html create mode 100644 docs/dyn/policytroubleshooter_v3beta.html create mode 100644 docs/dyn/policytroubleshooter_v3beta.iam.html create mode 100644 googleapiclient/discovery_cache/documents/policytroubleshooter.v3.json create mode 100644 googleapiclient/discovery_cache/documents/policytroubleshooter.v3beta.json diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index 16e77690e8..71be1a606d 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -123,7 +123,7 @@

Method Details

"createTime": "A String", # Output only. A timestamp identifying the time this key was originally created. "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", # Output only. 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. + "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. "name": "A String", # Output only. 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. @@ -251,7 +251,7 @@

Method Details

"createTime": "A String", # Output only. A timestamp identifying the time this key was originally created. "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", # Output only. 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. + "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. "name": "A String", # Output only. 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. @@ -338,7 +338,7 @@

Method Details

"createTime": "A String", # Output only. A timestamp identifying the time this key was originally created. "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", # Output only. 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. + "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. "name": "A String", # Output only. 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. @@ -413,7 +413,7 @@

Method Details

"createTime": "A String", # Output only. A timestamp identifying the time this key was originally created. "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", # Output only. 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. + "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. "name": "A String", # Output only. 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. diff --git a/docs/dyn/baremetalsolution_v2.projects.locations.html b/docs/dyn/baremetalsolution_v2.projects.locations.html index 0ab544dac8..eabca9ddcb 100644 --- a/docs/dyn/baremetalsolution_v2.projects.locations.html +++ b/docs/dyn/baremetalsolution_v2.projects.locations.html @@ -170,7 +170,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index adfc47aa3f..1f1cd0d9ab 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -452,8 +452,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -802,8 +802,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -1314,8 +1314,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -1664,8 +1664,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -2389,8 +2389,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -2739,8 +2739,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -3389,8 +3389,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -3739,8 +3739,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -4251,8 +4251,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -4601,8 +4601,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -5326,8 +5326,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -5676,8 +5676,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -6344,8 +6344,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -6694,8 +6694,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -7206,8 +7206,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -7556,8 +7556,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -8281,8 +8281,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -8631,8 +8631,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -9287,8 +9287,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -9637,8 +9637,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -10149,8 +10149,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -10499,8 +10499,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -11224,8 +11224,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -11574,8 +11574,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -12235,8 +12235,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -12585,8 +12585,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -13097,8 +13097,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -13447,8 +13447,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -14172,8 +14172,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -14522,8 +14522,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -15166,8 +15166,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -15516,8 +15516,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -16028,8 +16028,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -16378,8 +16378,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -17103,8 +17103,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -17453,8 +17453,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -18097,8 +18097,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -18447,8 +18447,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -18959,8 +18959,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -19309,8 +19309,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -20034,8 +20034,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -20384,8 +20384,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -21028,8 +21028,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -21378,8 +21378,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -21890,8 +21890,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -22240,8 +22240,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -22965,8 +22965,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -23315,8 +23315,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 2e135de889..73538b310d 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -567,8 +567,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -917,8 +917,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -1429,8 +1429,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -1779,8 +1779,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -2504,8 +2504,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -2854,8 +2854,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -3493,8 +3493,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -3843,8 +3843,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -4355,8 +4355,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -4705,8 +4705,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -5430,8 +5430,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -5780,8 +5780,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -6419,8 +6419,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -6769,8 +6769,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -7281,8 +7281,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -7631,8 +7631,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -8356,8 +8356,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -8706,8 +8706,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -9343,8 +9343,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -9693,8 +9693,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -10205,8 +10205,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -10555,8 +10555,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -11280,8 +11280,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -11630,8 +11630,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -12265,8 +12265,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -12615,8 +12615,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -13127,8 +13127,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -13477,8 +13477,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -14202,8 +14202,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -14552,8 +14552,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -15187,8 +15187,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -15537,8 +15537,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -16049,8 +16049,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -16399,8 +16399,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -17124,8 +17124,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -17474,8 +17474,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -18526,8 +18526,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -18876,8 +18876,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -19388,8 +19388,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -19738,8 +19738,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -20463,8 +20463,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -20813,8 +20813,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -21452,8 +21452,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -21802,8 +21802,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -22314,8 +22314,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -22664,8 +22664,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -23389,8 +23389,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -23739,8 +23739,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -24378,8 +24378,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -24728,8 +24728,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -25240,8 +25240,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -25590,8 +25590,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -26315,8 +26315,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -26665,8 +26665,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -27302,8 +27302,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -27652,8 +27652,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -28164,8 +28164,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -28514,8 +28514,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -29239,8 +29239,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -29589,8 +29589,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -30224,8 +30224,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -30574,8 +30574,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -31086,8 +31086,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -31436,8 +31436,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -32161,8 +32161,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -32511,8 +32511,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -33146,8 +33146,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -33496,8 +33496,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -34008,8 +34008,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -34358,8 +34358,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -35083,8 +35083,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # SelectionInput widget. - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). @@ -35433,8 +35433,8 @@

Method Details

"onClick": # Object with schema name: GoogleAppsCardV1OnClick # When a user clicks the image, the click triggers this action. }, "selectionInput": { # A widget that creates one or more UI items that users can select. Supports form submission validation for `dropdown` and `multiselect` menus only. When `Action.all_widgets_are_required` is set to `true` or this widget is specified in `Action.required_widgets`, the submission action is blocked unless a value is selected. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements). Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). To collect undefined or abstract data from users, use the TextInput widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a selection control that lets users select items. Selection controls can be checkboxes, radio buttons, switches, or dropdown menus. For example, the following JSON creates a dropdown menu that lets users choose a size: ``` "selectionInput": { "name": "size", "label": "Size" "type": "DROPDOWN", "items": [ { "text": "S", "value": "small", "selected": false }, { "text": "M", "value": "medium", "selected": true }, { "text": "L", "value": "large", "selected": false }, { "text": "XL", "value": "extra_large", "selected": false } ] } ``` - "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. - { # A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps. + "dataSourceConfigs": [ # Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used. + { # A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio. "platformDataSource": { # For a `SelectionInput` widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu. [Google Chat apps](https://developers.google.com/workspace/chat): # The data is from a Google Workspace application. "commonDataSource": "A String", # A data source shared by all Google Workspace applications, such as users in a Google Workspace organization. "hostAppDataSource": { # A data source from a Google Workspace application. The data source populates available items for a widget. # A data source that's unique to a Google Workspace host application, such spaces in Google Chat. This field supports the Google API Client Libraries but isn't available in the Cloud Client Libraries. To learn more, see [Install the client libraries](https://developers.google.com/workspace/chat/libraries). diff --git a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html index 8e8c6c8db1..3193e56aa0 100644 --- a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html +++ b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html @@ -105,7 +105,7 @@

Instance Methods

Retrieves the next page of results.

lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)

-

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

+

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.

lookup_next()

Retrieves the next page of results.

@@ -363,7 +363,7 @@

Method Details

lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None) -
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
+  
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.
 
 Args:
   parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required)
diff --git a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html
index 2f83e77ceb..55d3688a5c 100644
--- a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html
+++ b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html
@@ -105,7 +105,7 @@ 

Instance Methods

Retrieves the next page of results.

lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)

-

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

+

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.

lookup_next()

Retrieves the next page of results.

@@ -363,7 +363,7 @@

Method Details

lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None) -
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
+  
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.
 
 Args:
   parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required)
diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html
index 1e4e9fba47..15e3305d4f 100644
--- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html
+++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html
@@ -177,8 +177,8 @@ 

Method Details

"assignableEmployeeIds": [ # Optional. A list of specific employee IDs that can be assigned to shifts generated by this template. If this field is present, there will be `EmployeeSchedule`s in the response for which the `EmployeeSchedule.employee_id` field is set to one of the IDs in this list. The number of employee schedules with an assigned employee ID will be between `minimum_employee_count` and `maximum_employee_count`. If this field is empty, between `minimum_employee_count` and `maximum_employee_count` employees can be assigned to shifts generated by this template and the employee schedules won't have an assigned employee ID. Currently, only one assignable employee ID is supported. "A String", ], - "daysOffCountPerWeek": 42, # Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday. - "daysOffDates": { # List of dates. # Fixed dates when shifts from this template should not be generated. + "daysOffCountPerWeek": 42, # Optional. Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday. + "daysOffDates": { # List of dates. # Optional. Fixed dates when shifts from this template should not be generated. "values": [ # Optional. Values in the list. { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index 92aefaab9b..3a30e041e2 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -578,9 +578,9 @@

Method Details

project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field. + name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter} field. + type: string, Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html index 2613496da9..2456b95f68 100644 --- a/docs/dyn/dns_v1beta2.resourceRecordSets.html +++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html @@ -768,9 +768,9 @@

Method Details

project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field. + name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Restricts the list to return only records of this type. If present, the "name" parameter must also be present. Mutually exclusive with the {@code filter} field. + type: string, Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index da6d8611f8..04193efa68 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -166,7 +166,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -361,7 +361,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -687,7 +687,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -892,7 +892,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1230,7 +1230,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1490,7 +1490,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -1695,7 +1695,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. @@ -2033,7 +2033,7 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index a583f69c0e..6b5b4979f5 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -634,7 +634,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -983,7 +983,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -1698,7 +1698,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -2047,7 +2047,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -2794,7 +2794,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -3143,7 +3143,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -3871,7 +3871,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -4220,7 +4220,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -4950,7 +4950,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -5299,7 +5299,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -6009,7 +6009,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -6358,7 +6358,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -6963,7 +6963,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -7267,7 +7267,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index adb4c71a98..e748d4e74e 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -423,7 +423,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -727,7 +727,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -1354,7 +1354,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, @@ -1658,7 +1658,7 @@

Method Details

}, "selinux": { # SELinux details. # SELinux details. "enabled": True or False, # Is SELinux enabled. - "mode": "A String", # SELinux mode enforcing / permissive. + "mode": "A String", # SELinux mode disabled / enforcing / permissive. }, "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode. }, diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index e025e90ff2..b9bd77c726 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -419,7 +419,7 @@

Method Details

}, } - subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. + subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1066,7 +1066,7 @@

Method Details

MONTH - Unit of a calendar month. DAY - Unit of a day. HOUR - Unit of an hour. It is used for testing. - subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. + subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/policytroubleshooter_v3.html b/docs/dyn/policytroubleshooter_v3.html new file mode 100644 index 0000000000..1bac822811 --- /dev/null +++ b/docs/dyn/policytroubleshooter_v3.html @@ -0,0 +1,111 @@ + + + +

Policy Troubleshooter API

+

Instance Methods

+

+ iam() +

+

Returns the iam Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/policytroubleshooter_v3.iam.html b/docs/dyn/policytroubleshooter_v3.iam.html new file mode 100644 index 0000000000..07f12951fa --- /dev/null +++ b/docs/dyn/policytroubleshooter_v3.iam.html @@ -0,0 +1,412 @@ + + + +

Policy Troubleshooter API . iam

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ troubleshoot(body=None, x__xgafv=None)

+

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ troubleshoot(body=None, x__xgafv=None) +
Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for TroubleshootIamPolicy.
+  "accessTuple": { # Information about the principal, resource, and permission to check. # The information to use for checking whether a principal has a permission for a resource.
+    "conditionContext": { # Additional context for troubleshooting conditional role bindings and deny rules. # Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.
+      "destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop.
+        "ip": "A String", # The IPv4 or IPv6 address of the peer.
+        "port": "A String", # The network port of the peer.
+      },
+      "effectiveTags": [ # Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.
+        { # A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.
+          "inherited": True or False, # Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.
+          "namespacedTagKey": "A String", # Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.
+          "namespacedTagValue": "A String", # Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
+          "tagKey": "A String", # Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
+          "tagKeyParentName": "A String", # The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`
+          "tagValue": "A String", # Output only. Resource name for TagValue in the format `tagValues/456`.
+        },
+      ],
+      "request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.
+        "receiveTime": "A String", # Optional. The timestamp when the destination service receives the first byte of the request.
+      },
+      "resource": { # Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
+        "name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names
+        "service": "A String", # The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services
+        "type": "A String", # The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types
+      },
+    },
+    "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+    "permission": "A String", # Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+    "permissionFqdn": "A String", # Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.
+    "principal": "A String", # Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TroubleshootIamPolicy.
+  "accessTuple": { # Information about the principal, resource, and permission to check. # The access tuple from the request, including any provided context used to evaluate the condition.
+    "conditionContext": { # Additional context for troubleshooting conditional role bindings and deny rules. # Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.
+      "destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop.
+        "ip": "A String", # The IPv4 or IPv6 address of the peer.
+        "port": "A String", # The network port of the peer.
+      },
+      "effectiveTags": [ # Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.
+        { # A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.
+          "inherited": True or False, # Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.
+          "namespacedTagKey": "A String", # Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.
+          "namespacedTagValue": "A String", # Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
+          "tagKey": "A String", # Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
+          "tagKeyParentName": "A String", # The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`
+          "tagValue": "A String", # Output only. Resource name for TagValue in the format `tagValues/456`.
+        },
+      ],
+      "request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.
+        "receiveTime": "A String", # Optional. The timestamp when the destination service receives the first byte of the request.
+      },
+      "resource": { # Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
+        "name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names
+        "service": "A String", # The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services
+        "type": "A String", # The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types
+      },
+    },
+    "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+    "permission": "A String", # Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+    "permissionFqdn": "A String", # Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.
+    "principal": "A String", # Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.
+  },
+  "allowPolicyExplanation": { # Details about how the relevant IAM allow policies affect the final access state. # An explanation of how the applicable IAM allow policies affect the final access state.
+    "allowAccessState": "A String", # Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.
+    "explainedPolicies": [ # List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.
+      { # Details about how a specific IAM allow policy contributed to the final access state.
+        "allowAccessState": "A String", # Required. Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+        "bindingExplanations": [ # Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy. If the sender of the request does not have access to the policy, this field is omitted.
+          { # Details about how a role binding in an allow policy affects a principal's ability to use a permission.
+            "allowAccessState": "A String", # Required. Indicates whether _this role binding_ gives the specified permission to the specified principal on the specified resource. This field does _not_ indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+            "combinedMembership": { # Details about whether the role binding includes the principal. # The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly.
+              "membership": "A String", # Indicates whether the role binding includes the principal.
+              "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+            },
+            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # A condition expression that specifies when the role binding grants access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.
+              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+            },
+            "conditionExplanation": { # Explanation for how a condition affects a principal's access # Condition evaluation state for this role binding.
+              "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                  "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                  "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                  "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                },
+              ],
+              "evaluationStates": [ # The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.
+                { # Evaluated state of a condition expression.
+                  "end": 42, # End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.
+                  "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                    },
+                  ],
+                  "start": 42, # Start position of an expression in the condition, by character.
+                  "value": "", # Value of this expression.
+                },
+              ],
+              "value": "", # Value of the condition.
+            },
+            "memberships": { # Indicates whether each role binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the role binding, and each value indicates whether the principal in the role binding includes the principal in the request. For example, suppose that a role binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first principal in the role binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `NOT_INCLUDED`. For the second principal in the role binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `INCLUDED`.
+              "a_key": { # Details about whether the role binding includes the principal.
+                "membership": "A String", # Indicates whether the role binding includes the principal.
+                "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+              },
+            },
+            "relevance": "A String", # The relevance of this role binding to the overall determination for the entire policy.
+            "role": "A String", # The role that this role binding grants. For example, `roles/compute.admin`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+            "rolePermission": "A String", # Indicates whether the role granted by this role binding contains the specified permission.
+            "rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.
+          },
+        ],
+        "fullResourceName": "A String", # The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+        "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # The IAM allow policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.
+          "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+            { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+              "auditLogConfigs": [ # The configuration for logging of each type of permission.
+                { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+                  "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+                    "A String",
+                  ],
+                  "logType": "A String", # The log type that this config enables.
+                },
+              ],
+              "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+            },
+          ],
+          "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+            { # Associates `members`, or principals, with a `role`.
+              "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+                "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+              },
+              "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+                "A String",
+              ],
+              "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+            },
+          ],
+          "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+          "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        },
+        "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+      },
+    ],
+    "relevance": "A String", # The relevance of the allow policy type to the overall access state.
+  },
+  "denyPolicyExplanation": { # Details about how the relevant IAM deny policies affect the final access state. # An explanation of how the applicable IAM deny policies affect the final access state.
+    "denyAccessState": "A String", # Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.
+    "explainedResources": [ # List of resources with IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result. The list of resources includes the policy for the resource itself, as well as policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. The order of the resources starts from the resource and climbs up the resource hierarchy. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.
+      { # Details about how a specific resource contributed to the deny policy evaluation.
+        "denyAccessState": "A String", # Required. Indicates whether any policies attached to _this resource_ deny the specific permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+        "explainedPolicies": [ # List of IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result.
+          { # Details about how a specific IAM deny policy Policy contributed to the access check.
+            "denyAccessState": "A String", # Required. Indicates whether _this policy_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+            "policy": { # Data for an IAM policy. # The IAM deny policy attached to the resource. If the sender of the request does not have access to the policy, this field is omitted.
+              "annotations": { # A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters.
+                "a_key": "A String",
+              },
+              "createTime": "A String", # Output only. The time when the `Policy` was created.
+              "deleteTime": "A String", # Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
+              "displayName": "A String", # A user-specified description of the `Policy`. This value can be up to 63 characters.
+              "etag": "A String", # An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.
+              "kind": "A String", # Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
+              "name": "A String", # Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.
+              "rules": [ # A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`.
+                { # A single rule in a `Policy`.
+                  "denyRule": { # A deny rule in an IAM deny policy. # A rule for a deny policy.
+                    "denialCondition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to `true`, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate [resource tags](https://cloud.google.com/iam/help/conditions/resource-tags). Other functions and operators are not supported.
+                      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+                    },
+                    "deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`.
+                      "A String",
+                    ],
+                    "deniedPrincipals": [ #  The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+                      "A String",
+                    ],
+                    "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`.
+                      "A String",
+                    ],
+                    "exceptionPrincipals": [ # The identities that are excluded from the deny rule, even if they are listed in the `denied_principals`. For example, you could add a Google group to the `denied_principals`, then exclude specific users who belong to that group. This field can contain the same values as the `denied_principals` field, excluding `principalSet://goog/public:all`, which represents all users on the internet.
+                      "A String",
+                    ],
+                  },
+                  "description": "A String", # A user-specified description of the rule. This value can be up to 256 characters.
+                },
+              ],
+              "uid": "A String", # Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.
+              "updateTime": "A String", # Output only. The time when the `Policy` was last updated.
+            },
+            "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+            "ruleExplanations": [ # Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy. If the sender of the request does not have access to the policy, this field is omitted.
+              { # Details about how a deny rule in a deny policy affects a principal's ability to use a permission.
+                "combinedDeniedPermission": { # Details about whether the permission in the request is denied by the deny rule. # Indicates whether the permission in the request is listed as a denied permission in the deny rule.
+                  "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                  "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                },
+                "combinedDeniedPrincipal": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set. # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                },
+                "combinedExceptionPermission": { # Details about whether the permission in the request is denied by the deny rule. # Indicates whether the permission in the request is listed as an exception permission in the deny rule.
+                  "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                  "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                },
+                "combinedExceptionPrincipal": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set. # Indicates whether the principal is listed as an exception principal in the deny rule, either directly or through membership in a principal set.
+                  "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                },
+                "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # A condition expression that specifies when the deny rule denies the principal access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.
+                  "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                  "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                  "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                  "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+                },
+                "conditionExplanation": { # Explanation for how a condition affects a principal's access # Condition evaluation state for this role binding.
+                  "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                    },
+                  ],
+                  "evaluationStates": [ # The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.
+                    { # Evaluated state of a condition expression.
+                      "end": 42, # End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.
+                      "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                            {
+                              "a_key": "", # Properties of the object. Contains field @type with type URL.
+                            },
+                          ],
+                          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                        },
+                      ],
+                      "start": 42, # Start position of an expression in the condition, by character.
+                      "value": "", # Value of this expression.
+                    },
+                  ],
+                  "value": "", # Value of the condition.
+                },
+                "deniedPermissions": { # Lists all denied permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a denied permission in the rule, and each value indicates whether the denied permission matches the permission in the request.
+                  "a_key": { # Details about whether the permission in the request is denied by the deny rule.
+                    "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                    "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                  },
+                },
+                "deniedPrincipals": { # Lists all denied principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a denied principal in the rule, and each value indicates whether the denied principal matches the principal in the request.
+                  "a_key": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                  },
+                },
+                "denyAccessState": "A String", # Required. Indicates whether _this rule_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal is actually denied on the permission for the resource. There might be another rule that overrides this rule. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+                "exceptionPermissions": { # Lists all exception permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a exception permission in the rule, and each value indicates whether the exception permission matches the permission in the request.
+                  "a_key": { # Details about whether the permission in the request is denied by the deny rule.
+                    "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                    "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                  },
+                },
+                "exceptionPrincipals": { # Lists all exception principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a exception principal in the rule, and each value indicates whether the exception principal matches the principal in the request.
+                  "a_key": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                  },
+                },
+                "relevance": "A String", # The relevance of this role binding to the overall determination for the entire policy.
+              },
+            ],
+          },
+        ],
+        "fullResourceName": "A String", # The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+        "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+      },
+    ],
+    "permissionDeniable": True or False, # Indicates whether the permission to troubleshoot is supported in deny policies.
+    "relevance": "A String", # The relevance of the deny policy result to the overall access state.
+  },
+  "overallAccessState": "A String", # Indicates whether the principal has the specified permission for the specified resource, based on evaluating all types of the applicable IAM policies.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/policytroubleshooter_v3beta.html b/docs/dyn/policytroubleshooter_v3beta.html new file mode 100644 index 0000000000..c51ece9c6e --- /dev/null +++ b/docs/dyn/policytroubleshooter_v3beta.html @@ -0,0 +1,111 @@ + + + +

Policy Troubleshooter API

+

Instance Methods

+

+ iam() +

+

Returns the iam Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/policytroubleshooter_v3beta.iam.html b/docs/dyn/policytroubleshooter_v3beta.iam.html new file mode 100644 index 0000000000..2aef71cd31 --- /dev/null +++ b/docs/dyn/policytroubleshooter_v3beta.iam.html @@ -0,0 +1,528 @@ + + + +

Policy Troubleshooter API . iam

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ troubleshoot(body=None, x__xgafv=None)

+

Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ troubleshoot(body=None, x__xgafv=None) +
Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for TroubleshootIamPolicy.
+  "accessTuple": { # Information about the principal, resource, and permission to check. # The information to use for checking whether a principal has a permission for a resource.
+    "conditionContext": { # Additional context for troubleshooting conditional role bindings and deny rules. # Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.
+      "destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop.
+        "ip": "A String", # The IPv4 or IPv6 address of the peer.
+        "port": "A String", # The network port of the peer.
+      },
+      "effectiveTags": [ # Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.
+        { # A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.
+          "inherited": True or False, # Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.
+          "namespacedTagKey": "A String", # Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.
+          "namespacedTagValue": "A String", # Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
+          "tagKey": "A String", # Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
+          "tagKeyParentName": "A String", # The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`
+          "tagValue": "A String", # Output only. Resource name for TagValue in the format `tagValues/456`.
+        },
+      ],
+      "request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.
+        "receiveTime": "A String", # Optional. The timestamp when the destination service receives the first byte of the request.
+      },
+      "resource": { # Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
+        "name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names
+        "service": "A String", # The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services
+        "type": "A String", # The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types
+      },
+    },
+    "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+    "permission": "A String", # Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+    "permissionFqdn": "A String", # Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.
+    "principal": "A String", # Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TroubleshootIamPolicy.
+  "accessTuple": { # Information about the principal, resource, and permission to check. # The access tuple from the request, including any provided context used to evaluate the condition.
+    "conditionContext": { # Additional context for troubleshooting conditional role bindings and deny rules. # Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.
+      "destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop.
+        "ip": "A String", # The IPv4 or IPv6 address of the peer.
+        "port": "A String", # The network port of the peer.
+      },
+      "effectiveTags": [ # Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.
+        { # A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.
+          "inherited": True or False, # Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.
+          "namespacedTagKey": "A String", # Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.
+          "namespacedTagValue": "A String", # Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.
+          "tagKey": "A String", # Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
+          "tagKeyParentName": "A String", # The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`
+          "tagValue": "A String", # Output only. Resource name for TagValue in the format `tagValues/456`.
+        },
+      ],
+      "request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.
+        "receiveTime": "A String", # Optional. The timestamp when the destination service receives the first byte of the request.
+      },
+      "resource": { # Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.
+        "name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names
+        "service": "A String", # The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services
+        "type": "A String", # The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types
+      },
+    },
+    "fullResourceName": "A String", # Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+    "permission": "A String", # Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+    "permissionFqdn": "A String", # Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.
+    "principal": "A String", # Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.
+  },
+  "allowPolicyExplanation": { # Details about how the relevant IAM allow policies affect the final access state. # An explanation of how the applicable IAM allow policies affect the final access state.
+    "allowAccessState": "A String", # Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.
+    "explainedPolicies": [ # List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.
+      { # Details about how a specific IAM allow policy contributed to the final access state.
+        "allowAccessState": "A String", # Required. Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+        "bindingExplanations": [ # Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy. If the sender of the request does not have access to the policy, this field is omitted.
+          { # Details about how a role binding in an allow policy affects a principal's ability to use a permission.
+            "allowAccessState": "A String", # Required. Indicates whether _this role binding_ gives the specified permission to the specified principal on the specified resource. This field does _not_ indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+            "combinedMembership": { # Details about whether the role binding includes the principal. # The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly.
+              "membership": "A String", # Indicates whether the role binding includes the principal.
+              "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+            },
+            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # A condition expression that specifies when the role binding grants access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.
+              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+            },
+            "conditionExplanation": { # Explanation for how a condition affects a principal's access # Condition evaluation state for this role binding.
+              "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                  "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                  "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                    {
+                      "a_key": "", # Properties of the object. Contains field @type with type URL.
+                    },
+                  ],
+                  "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                },
+              ],
+              "evaluationStates": [ # The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.
+                { # Evaluated state of a condition expression.
+                  "end": 42, # End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.
+                  "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                    },
+                  ],
+                  "start": 42, # Start position of an expression in the condition, by character.
+                  "value": "", # Value of this expression.
+                },
+              ],
+              "value": "", # Value of the condition.
+            },
+            "memberships": { # Indicates whether each role binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the role binding, and each value indicates whether the principal in the role binding includes the principal in the request. For example, suppose that a role binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first principal in the role binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `NOT_INCLUDED`. For the second principal in the role binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `INCLUDED`.
+              "a_key": { # Details about whether the role binding includes the principal.
+                "membership": "A String", # Indicates whether the role binding includes the principal.
+                "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+              },
+            },
+            "relevance": "A String", # The relevance of this role binding to the overall determination for the entire policy.
+            "role": "A String", # The role that this role binding grants. For example, `roles/compute.admin`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
+            "rolePermission": "A String", # Indicates whether the role granted by this role binding contains the specified permission.
+            "rolePermissionRelevance": "A String", # The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.
+          },
+        ],
+        "fullResourceName": "A String", # The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+        "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # The IAM allow policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty.
+          "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+            { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+              "auditLogConfigs": [ # The configuration for logging of each type of permission.
+                { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+                  "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+                    "A String",
+                  ],
+                  "logType": "A String", # The log type that this config enables.
+                },
+              ],
+              "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+            },
+          ],
+          "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+            { # Associates `members`, or principals, with a `role`.
+              "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+                "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+              },
+              "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+                "A String",
+              ],
+              "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+            },
+          ],
+          "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+          "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        },
+        "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+      },
+    ],
+    "relevance": "A String", # The relevance of the allow policy type to the overall access state.
+  },
+  "denyPolicyExplanation": { # Details about how the relevant IAM deny policies affect the final access state. # An explanation of how the applicable IAM deny policies affect the final access state.
+    "denyAccessState": "A String", # Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.
+    "explainedResources": [ # List of resources with IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result. The list of resources includes the policy for the resource itself, as well as policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. The order of the resources starts from the resource and climbs up the resource hierarchy. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.
+      { # Details about how a specific resource contributed to the deny policy evaluation.
+        "denyAccessState": "A String", # Required. Indicates whether any policies attached to _this resource_ deny the specific permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+        "explainedPolicies": [ # List of IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result.
+          { # Details about how a specific IAM deny policy Policy contributed to the access check.
+            "denyAccessState": "A String", # Required. Indicates whether _this policy_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+            "policy": { # Data for an IAM policy. # The IAM deny policy attached to the resource. If the sender of the request does not have access to the policy, this field is omitted.
+              "annotations": { # A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters.
+                "a_key": "A String",
+              },
+              "createTime": "A String", # Output only. The time when the `Policy` was created.
+              "deleteTime": "A String", # Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.
+              "displayName": "A String", # A user-specified description of the `Policy`. This value can be up to 63 characters.
+              "etag": "A String", # An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.
+              "kind": "A String", # Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
+              "name": "A String", # Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.
+              "rules": [ # A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`.
+                { # A single rule in a `Policy`.
+                  "denyRule": { # A deny rule in an IAM deny policy. # A rule for a deny policy.
+                    "denialCondition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to `true`, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate [resource tags](https://cloud.google.com/iam/help/conditions/resource-tags). Other functions and operators are not supported.
+                      "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                      "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                      "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                      "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+                    },
+                    "deniedPermissions": [ # The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`.
+                      "A String",
+                    ],
+                    "deniedPrincipals": [ #  The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+                      "A String",
+                    ],
+                    "exceptionPermissions": [ # Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`.
+                      "A String",
+                    ],
+                    "exceptionPrincipals": [ # The identities that are excluded from the deny rule, even if they are listed in the `denied_principals`. For example, you could add a Google group to the `denied_principals`, then exclude specific users who belong to that group. This field can contain the same values as the `denied_principals` field, excluding `principalSet://goog/public:all`, which represents all users on the internet.
+                      "A String",
+                    ],
+                  },
+                  "description": "A String", # A user-specified description of the rule. This value can be up to 256 characters.
+                },
+              ],
+              "uid": "A String", # Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.
+              "updateTime": "A String", # Output only. The time when the `Policy` was last updated.
+            },
+            "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+            "ruleExplanations": [ # Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy. If the sender of the request does not have access to the policy, this field is omitted.
+              { # Details about how a deny rule in a deny policy affects a principal's ability to use a permission.
+                "combinedDeniedPermission": { # Details about whether the permission in the request is denied by the deny rule. # Indicates whether the permission in the request is listed as a denied permission in the deny rule.
+                  "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                  "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                },
+                "combinedDeniedPrincipal": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set. # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                },
+                "combinedExceptionPermission": { # Details about whether the permission in the request is denied by the deny rule. # Indicates whether the permission in the request is listed as an exception permission in the deny rule.
+                  "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                  "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                },
+                "combinedExceptionPrincipal": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set. # Indicates whether the principal is listed as an exception principal in the deny rule, either directly or through membership in a principal set.
+                  "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                  "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                },
+                "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # A condition expression that specifies when the deny rule denies the principal access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview.
+                  "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+                  "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+                  "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+                  "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+                },
+                "conditionExplanation": { # Explanation for how a condition affects a principal's access # Condition evaluation state for this role binding.
+                  "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                        {
+                          "a_key": "", # Properties of the object. Contains field @type with type URL.
+                        },
+                      ],
+                      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                    },
+                  ],
+                  "evaluationStates": [ # The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.
+                    { # Evaluated state of a condition expression.
+                      "end": 42, # End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.
+                      "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                            {
+                              "a_key": "", # Properties of the object. Contains field @type with type URL.
+                            },
+                          ],
+                          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                        },
+                      ],
+                      "start": 42, # Start position of an expression in the condition, by character.
+                      "value": "", # Value of this expression.
+                    },
+                  ],
+                  "value": "", # Value of the condition.
+                },
+                "deniedPermissions": { # Lists all denied permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a denied permission in the rule, and each value indicates whether the denied permission matches the permission in the request.
+                  "a_key": { # Details about whether the permission in the request is denied by the deny rule.
+                    "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                    "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                  },
+                },
+                "deniedPrincipals": { # Lists all denied principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a denied principal in the rule, and each value indicates whether the denied principal matches the principal in the request.
+                  "a_key": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                  },
+                },
+                "denyAccessState": "A String", # Required. Indicates whether _this rule_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal is actually denied on the permission for the resource. There might be another rule that overrides this rule. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.
+                "exceptionPermissions": { # Lists all exception permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a exception permission in the rule, and each value indicates whether the exception permission matches the permission in the request.
+                  "a_key": { # Details about whether the permission in the request is denied by the deny rule.
+                    "permissionMatchingState": "A String", # Indicates whether the permission in the request is denied by the deny rule.
+                    "relevance": "A String", # The relevance of the permission status to the overall determination for the rule.
+                  },
+                },
+                "exceptionPrincipals": { # Lists all exception principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a exception principal in the rule, and each value indicates whether the exception principal matches the principal in the request.
+                  "a_key": { # Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "membership": "A String", # Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.
+                    "relevance": "A String", # The relevance of the principal's status to the overall determination for the role binding.
+                  },
+                },
+                "relevance": "A String", # The relevance of this role binding to the overall determination for the entire policy.
+              },
+            ],
+          },
+        ],
+        "fullResourceName": "A String", # The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
+        "relevance": "A String", # The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.
+      },
+    ],
+    "permissionDeniable": True or False, # Indicates whether the permission to troubleshoot is supported in deny policies.
+    "relevance": "A String", # The relevance of the deny policy result to the overall access state.
+  },
+  "overallAccessState": "A String", # Indicates whether the principal has the specified permission for the specified resource, based on evaluating all types of the applicable IAM policies.
+  "pabPolicyExplanation": { # Details about how the relevant principal access boundary policies affect the overall access state. # An explanation of how the applicable principal access boundary policies affect the final access state.
+    "explainedBindingsAndPolicies": [ # List of principal access boundary policies and bindings that are applicable to the principal's access state, with annotations to indicate how each binding and policy contributes to the overall access state.
+      { # Details about how a principal access boundary binding and policy contributes to the principal access boundary explanation, with annotations to indicate how the binding and policy contribute to the overall access state.
+        "bindingAndPolicyAccessState": "A String", # Output only. Indicates whether the principal is allowed to access the specified resource based on evaluating the binding and policy.
+        "explainedPolicy": { # Details about how a principal access boundary policy contributes to the explanation, with annotations to indicate how the policy contributes to the overall access state. # Optional. Details about how this policy contributes to the principal access boundary explanation, with annotations to indicate how the policy contributes to the overall access state. If the caller doesn't have permission to view the policy in the binding, this field is omitted.
+          "explainedRules": [ # List of principal access boundary rules that were explained to check the principal's access to specified resource, with annotations to indicate how each rule contributes to the overall access state.
+            { # Details about how a principal access boundary rule contributes to the explanation, with annotations to indicate how the rule contributes to the overall access state.
+              "combinedResourceInclusionState": "A String", # Output only. Indicates whether any resource of the rule is the specified resource or includes the specified resource.
+              "effect": "A String", # Required. The effect of the rule which describes the access relationship.
+              "explainedResources": [ # List of resources that were explained to check the principal's access to specified resource, with annotations to indicate how each resource contributes to the overall access state.
+                { # Details about how a resource contributes to the explanation, with annotations to indicate how the resource contributes to the overall access state.
+                  "relevance": "A String", # The relevance of this resource to the overall access state.
+                  "resource": "A String", # The [full resource name](https://cloud.google.com/iam/docs/full-resource-names) that identifies the resource that is explained. This can only be a project, a folder, or an organization which is what a PAB rule accepts.
+                  "resourceInclusionState": "A String", # Output only. Indicates whether the resource is the specified resource or includes the specified resource.
+                },
+              ],
+              "relevance": "A String", # The relevance of this rule to the overall access state.
+              "ruleAccessState": "A String", # Output only. Indicates whether the rule allows access to the specified resource.
+            },
+          ],
+          "policy": { # An IAM principal access boundary policy resource. # The policy that is explained.
+            "annotations": { # Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations
+              "a_key": "A String",
+            },
+            "createTime": "A String", # Output only. The time when the principal access boundary policy was created.
+            "details": { # Principal access boundary policy details # Optional. The details for the principal access boundary policy.
+              "enforcementVersion": "A String", # Optional. The version number (for example, `1` or `latest`) that indicates which permissions are able to be blocked by the policy. If empty, the PAB policy version will be set to the most recent version number at the time of the policy's creation.
+              "rules": [ # Required. A list of principal access boundary policy rules. The number of rules in a policy is limited to 500.
+                { # Principal access boundary policy rule that defines the resource boundary.
+                  "description": "A String", # Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.
+                  "effect": "A String", # Required. The access relationship of principals to the resources in this rule.
+                  "resources": [ # Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy. The following resource types are supported: * Organizations, such as `//cloudresourcemanager.googleapis.com/organizations/123`. * Folders, such as `//cloudresourcemanager.googleapis.com/folders/123`. * Projects, such as `//cloudresourcemanager.googleapis.com/projects/123` or `//cloudresourcemanager.googleapis.com/projects/my-project-id`.
+                    "A String",
+                  ],
+                },
+              ],
+            },
+            "displayName": "A String", # Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.
+            "etag": "A String", # Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.
+            "name": "A String", # Identifier. The resource name of the principal access boundary policy. The following format is supported: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}`
+            "uid": "A String", # Output only. The globally unique ID of the principal access boundary policy.
+            "updateTime": "A String", # Output only. The time when the principal access boundary policy was most recently updated.
+          },
+          "policyAccessState": "A String", # Output only. Indicates whether the policy allows access to the specified resource.
+          "policyVersion": { # Details about how a principal access boundary policy's version contributes to the policy's enforcement state. # Output only. Explanation of the principal access boundary policy's version.
+            "enforcementState": "A String", # Output only. Indicates whether the policy is enforced based on its version.
+            "version": 42, # Output only. The actual version of the policy. - If the policy uses static version, this field is the chosen static version. - If the policy uses dynamic version, this field is the effective latest version.
+          },
+          "relevance": "A String", # The relevance of this policy to the overall access state.
+        },
+        "explainedPolicyBinding": { # Details about how a policy binding contributes to the policy explanation, with annotations to indicate how the policy binding contributes to the overall access state. # Details about how this binding contributes to the principal access boundary explanation, with annotations to indicate how the binding contributes to the overall access state.
+          "conditionExplanation": { # Explanation for how a condition affects a principal's access # Optional. Explanation of the condition in the policy binding. If the policy binding doesn't have a condition, this field is omitted.
+            "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+              { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+                "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+              },
+            ],
+            "evaluationStates": [ # The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.
+              { # Evaluated state of a condition expression.
+                "end": 42, # End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.
+                "errors": [ # Any errors that prevented complete evaluation of the condition expression.
+                  { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+                    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+                    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+                  },
+                ],
+                "start": 42, # Start position of an expression in the condition, by character.
+                "value": "", # Value of this expression.
+              },
+            ],
+            "value": "", # Value of the condition.
+          },
+          "policyBinding": { # IAM policy binding resource. # The policy binding that is explained.
+            "annotations": { # Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations
+              "a_key": "A String",
+            },
+            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # Optional. The condition to apply to the policy binding. When set, the `expression` field in the `Expr` must include from 1 to 10 subexpressions, joined by the "||"(Logical OR), "&&"(Logical AND) or "!"(Logical NOT) operators and cannot contain more than 250 characters. The condition is currently only supported when bound to policies of kind principal access boundary. When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are `principal.type` and `principal.subject`. An example expression is: "principal.type == 'iam.googleapis.com/ServiceAccount'" or "principal.subject == 'bob@example.com'". Allowed operations for `principal.subject`: - `principal.subject == ` - `principal.subject != ` - `principal.subject in []` - `principal.subject.startsWith()` - `principal.subject.endsWith()` Allowed operations for `principal.type`: - `principal.type == ` - `principal.type != ` - `principal.type in []` Supported principal types are Workspace, Workforce Pool, Workload Pool and Service Account. Allowed string must be one of: - iam.googleapis.com/WorkspaceIdentity - iam.googleapis.com/WorkforcePoolIdentity - iam.googleapis.com/WorkloadPoolIdentity - iam.googleapis.com/ServiceAccount
+              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+            },
+            "createTime": "A String", # Output only. The time when the policy binding was created.
+            "displayName": "A String", # Optional. The description of the policy binding. Must be less than or equal to 63 characters.
+            "etag": "A String", # Optional. The etag for the policy binding. If this is provided on update, it must match the server's etag.
+            "name": "A String", # Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`
+            "policy": "A String", # Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same organization.
+            "policyKind": "A String", # Immutable. The kind of the policy to attach in this binding. This field must be one of the following: - Left empty (will be automatically set to the policy kind) - The input policy kind
+            "policyUid": "A String", # Output only. The globally unique ID of the policy to be bound.
+            "target": { # The full resource name of the resource to which the policy will be bound. Immutable once set. # Required. Immutable. The full resource name of the resource to which the policy will be bound. Immutable once set.
+              "principalSet": "A String", # Immutable. The full resource name that's used for principal access boundary policy bindings. The principal set must be directly parented by the policy binding's parent or same as the parent if the target is a project, folder, or organization. Examples: * For bindings parented by an organization: * Organization: `//cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID` * Workforce Identity: `//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID` * Workspace Identity: `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * For bindings parented by a folder: * Folder: `//cloudresourcemanager.googleapis.com/folders/FOLDER_ID` * For bindings parented by a project: * Project: * `//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER` * `//cloudresourcemanager.googleapis.com/projects/PROJECT_ID` * Workload Identity Pool: `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID`
+              "resource": "A String", # Immutable. The full resource name that's used for access policy bindings. Examples: * Organization: `//cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID` * Folder: `//cloudresourcemanager.googleapis.com/folders/FOLDER_ID` * Project: * `//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER` * `//cloudresourcemanager.googleapis.com/projects/PROJECT_ID`
+            },
+            "uid": "A String", # Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.
+            "updateTime": "A String", # Output only. The time when the policy binding was most recently updated.
+          },
+          "policyBindingState": "A String", # Output only. Indicates whether the policy binding takes effect.
+          "relevance": "A String", # The relevance of this policy binding to the overall access state.
+        },
+        "relevance": "A String", # The relevance of this principal access boundary binding and policy to the overall access state.
+      },
+    ],
+    "principalAccessBoundaryAccessState": "A String", # Output only. Indicates whether the principal is allowed to access specified resource, based on evaluating all applicable principal access boundary bindings and policies.
+    "relevance": "A String", # The relevance of the principal access boundary access state to the overall access state.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html index 02f43f215a..6a14f3b8bd 100644 --- a/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html +++ b/docs/dyn/realtimebidding_v1.bidders.pretargetingConfigs.html @@ -832,7 +832,7 @@

Method Details

Gets a pretargeting configuration.
 
 Args:
-  name: string, Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId} (required)
+  name: string, Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfigs/{configId} (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index e060c83f20..3170eecaed 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -107,7 +107,7 @@ 

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -461,7 +461,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -495,7 +495,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.domainmappings.html b/docs/dyn/run_v1.namespaces.domainmappings.html index b95640ebf2..c9c1d5f3ac 100644 --- a/docs/dyn/run_v1.namespaces.domainmappings.html +++ b/docs/dyn/run_v1.namespaces.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index f44675462f..da8056ba6c 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -476,7 +476,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -799,7 +799,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index 3e3f8db767..c908df6dfe 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -150,7 +150,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -458,7 +458,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -494,7 +494,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -853,7 +853,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -889,7 +889,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1214,7 +1214,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1250,7 +1250,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1571,7 +1571,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1607,7 +1607,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1915,7 +1915,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1951,7 +1951,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2309,7 +2309,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index f497b85b06..ec476c1df2 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -475,7 +475,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.routes.html b/docs/dyn/run_v1.namespaces.routes.html index e86f8807d9..61c038709f 100644 --- a/docs/dyn/run_v1.namespaces.routes.html +++ b/docs/dyn/run_v1.namespaces.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 2f4938799e..501284da53 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -111,7 +111,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -145,7 +145,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -473,7 +473,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -507,7 +507,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -886,7 +886,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -920,7 +920,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1264,7 +1264,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1298,7 +1298,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1638,7 +1638,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1672,7 +1672,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2000,7 +2000,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2034,7 +2034,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index bc6fbe42e9..e72a8e9035 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -434,7 +434,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index 1603a567ef..3eb9d03877 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -111,7 +111,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -152,7 +152,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -463,7 +463,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -504,7 +504,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -863,7 +863,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -904,7 +904,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1227,7 +1227,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1268,7 +1268,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1591,7 +1591,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1632,7 +1632,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1943,7 +1943,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "run.googleapis.com/v1". "kind": "A String", # The kind of resource. It must be "WorkerPool". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this WorkerPool, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in WorkerPool.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/description` - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1984,7 +1984,7 @@

Method Details

], "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index b15fb073e2..4a3ada5f7e 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -461,7 +461,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -495,7 +495,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.domainmappings.html b/docs/dyn/run_v1.projects.locations.domainmappings.html index 7c6b956330..9d2c8cb339 100644 --- a/docs/dyn/run_v1.projects.locations.domainmappings.html +++ b/docs/dyn/run_v1.projects.locations.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 3be4a5c113..17f4b01421 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -475,7 +475,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.routes.html b/docs/dyn/run_v1.projects.locations.routes.html index a4c694c33a..3b244fc5a3 100644 --- a/docs/dyn/run_v1.projects.locations.routes.html +++ b/docs/dyn/run_v1.projects.locations.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index ab3758771e..219695d296 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -120,7 +120,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -154,7 +154,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -482,7 +482,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -516,7 +516,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -895,7 +895,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -929,7 +929,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1321,7 +1321,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1355,7 +1355,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1695,7 +1695,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1729,7 +1729,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2057,7 +2057,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2091,7 +2091,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/health-check-disabled`: if true, deploy-time startup probes will not run for this revision. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index 7d2e36413a..03555f3746 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -350,7 +350,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, } @@ -498,7 +498,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. Priority is ignored for this request. Setting the priority in this `request_options` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, } @@ -633,7 +633,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "returnCommitStats": True or False, # If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`. "singleUseTransaction": { # Options to use for transactions. # Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. @@ -752,7 +752,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "seqno": "A String", # Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution. "statements": [ # Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement `i` are visible to statement `i+1`. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. @@ -988,7 +988,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "resumeToken": "A String", # If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. "seqno": "A String", # A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries. @@ -1185,7 +1185,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "resumeToken": "A String", # If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. "seqno": "A String", # A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries. @@ -1672,7 +1672,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "resumeToken": "A String", # If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. "table": "A String", # Required. The name of the table in the database to be read. @@ -1899,7 +1899,7 @@

Method Details

"requestOptions": { # Common request options for various APIs. # Common options for this request. "priority": "A String", # Priority for the request. "requestTag": "A String", # A per-request tag which can be applied to queries or reads, used for statistics collection. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, `CommitRequest`). Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. - "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. + "transactionTag": "A String", # A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string. }, "resumeToken": "A String", # If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. "table": "A String", # Required. The name of the table in the database to be read. diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 55930eaf06..603e5ebc81 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, -"revision": "20241016", +"revision": "20260109", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { @@ -575,8 +575,7 @@ "type": "string" }, "etag": { -"description": "Output only. 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.", -"readOnly": true, +"description": "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.", "type": "string" }, "keyString": { diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json index 9643c6debf..87e85dd5e9 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1728,7 +1728,7 @@ } } }, -"revision": "20251008", +"revision": "20260112", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 7486c9ae3b..df9131cda7 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1535,7 +1535,7 @@ } } }, -"revision": "20260101", +"revision": "20260108", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2987,7 +2987,7 @@ "type": "object" }, "GoogleAppsCardV1DataSourceConfig": { -"description": "A configuration object that helps configure the data sources for a widget. Available for Google Workspace add-ons that extend Google Workspace Studio. Unavailable for Google Chat apps.", +"description": "A configuration object that helps configure the data sources for a widget. Available for Google Chat apps and Google Workspace add-ons that extend Google Workspace Studio.", "id": "GoogleAppsCardV1DataSourceConfig", "properties": { "platformDataSource": { @@ -3583,7 +3583,7 @@ "id": "GoogleAppsCardV1SelectionInput", "properties": { "dataSourceConfigs": { -"description": "Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` widget in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.", +"description": "Optional. The data source configs for the selection control. This field provides more fine-grained control over the data source. If specified, the `multi_select_max_selected_items` field, `multi_select_min_query_length` field, `external_data_source` field and `platform_data_source` field are ignored. Available for Google Workspace add-ons that extend Google Workspace Studio. Available for the `Dropdown widget` in Google Chat apps as part of the [Developer Preview Program](https://developers.google.com/workspace/preview). For the `Dropdown` widget in Google Chat apps, only one `DataSourceConfig` is supported. If multiple `DataSourceConfig`s are set, only the first one is used.", "items": { "$ref": "GoogleAppsCardV1DataSourceConfig" }, diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index cca161de6f..7200bcb999 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -680,7 +680,7 @@ ] }, "lookup": { -"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", +"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.", "flatPath": "v1/devices/{devicesId}/deviceUsers:lookup", "httpMethod": "GET", "id": "cloudidentity.devices.deviceUsers.lookup", @@ -2240,7 +2240,7 @@ } } }, -"revision": "20251208", +"revision": "20260113", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 00bfc6e876..7431a1eca6 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -680,7 +680,7 @@ ] }, "lookup": { -"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.", +"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: If either the `partner` or `ios_device_id` field is provided, then both fields are required. - Android: Specifying the `android_id` field is required. - Desktop: Specifying the `raw_resource_id` field is required.", "flatPath": "v1beta1/devices/{devicesId}/deviceUsers:lookup", "httpMethod": "GET", "id": "cloudidentity.devices.deviceUsers.lookup", @@ -2349,7 +2349,7 @@ } } }, -"revision": "20251208", +"revision": "20260113", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 5fd49acad3..54d84dd592 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -551,7 +551,7 @@ } } }, -"revision": "20251204", +"revision": "20260108", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -1465,13 +1465,13 @@ "type": "array" }, "daysOffCountPerWeek": { -"description": "Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday.", +"description": "Optional. Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday.", "format": "int32", "type": "integer" }, "daysOffDates": { "$ref": "DateList", -"description": "Fixed dates when shifts from this template should not be generated." +"description": "Optional. Fixed dates when shifts from this template should not be generated." }, "durationMinutes": { "description": "Required. Fixed duration of a shift generated by this template.", diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index 6a51b19b27..506d9de4d5 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1237,7 +1237,7 @@ "type": "integer" }, "name": { -"description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", +"description": "Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.", "location": "query", "type": "string" }, @@ -1253,7 +1253,7 @@ "type": "string" }, "type": { -"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", +"description": "Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter.", "location": "query", "type": "string" } @@ -1824,7 +1824,7 @@ } } }, -"revision": "20250828", +"revision": "20260113", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 5014c18f62..101fa6dd32 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1234,7 +1234,7 @@ "type": "integer" }, "name": { -"description": "Restricts the list to return only records with this fully qualified domain name. Mutually exclusive with the {@code filter} field.", +"description": "Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.", "location": "query", "type": "string" }, @@ -1250,7 +1250,7 @@ "type": "string" }, "type": { -"description": "Restricts the list to return only records of this type. If present, the \"name\" parameter must also be present. Mutually exclusive with the {@code filter} field.", +"description": "Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter.", "location": "query", "type": "string" } @@ -1821,7 +1821,7 @@ } } }, -"revision": "20250828", +"revision": "20260113", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index e70cb31812..0f45c7530b 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20251214", +"revision": "20260111", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1956,7 +1956,7 @@ "description": "per part media resolution. Media resolution for the input media." }, "text": { -"description": "Optional. The text content of the part.", +"description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", "type": "string" }, "thought": { diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index 9976d70206..e93ca58398 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -242,7 +242,7 @@ } } }, -"revision": "20251207", +"revision": "20260111", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -859,6 +859,20 @@ "GOOGLE_RESPONSE_TO_PRODUCTION_ALERT", "CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +true, +true, +false, +false +], "enumDescriptions": [ "Unspecified access reason.", "Customer-initiated support.", @@ -868,8 +882,8 @@ "Customer uses their account to perform any access to their own data which their IAM policy authorizes.", "Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer.", "No reason is expected for this key request.", -"Customer uses their account to perform any access to their own data which their IAM policy authorizes, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.", -"Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.", +"Deprecated: This code is no longer generated by Google Cloud. The GOOGLE_RESPONSE_TO_PRODUCTION_ALERT justification codes available in both Key Access Justifications and Access Transparency logs provide customer-visible signals of emergency access in more precise contexts. Customer uses their account to perform any access to their own data which their IAM policy authorizes, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.", +"Deprecated: This code is no longer generated by Google Cloud. The GOOGLE_RESPONSE_TO_PRODUCTION_ALERT justification codes available in both Key Access Justifications and Access Transparency logs provide customer-visible signals of emergency access in more precise contexts. Google systems access customer data to help optimize the structure of the data or quality for future uses by the customer, and one of the following is true: * A Google administrator has reset the root-access account associated with the user's organization within the past 7 days. * A Google-initiated emergency access operation has interacted with a resource in the same project or folder as the currently accessed resource within the past 7 days.", "Google-initiated access to maintain system reliability.", "One of the following operations is being executed while simultaneously encountering an internal technical issue which prevented a more precise justification code from being generated: * Your account has been used to perform any access to your own data which your IAM policy authorizes. * An automated Google system operates on encrypted customer data which your IAM policy authorizes. * Customer-initiated Google support access. * Google-initiated support access to protect system reliability." ], diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 3ce2119fb8..b2cf1deff6 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2722,7 +2722,7 @@ } } }, -"revision": "20251203", +"revision": "20260115", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -8824,7 +8824,7 @@ false "type": "boolean" }, "mode": { -"description": "SELinux mode enforcing / permissive.", +"description": "SELinux mode disabled / enforcing / permissive.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index c7fc06d0b3..05ffd9de5c 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -272,7 +272,7 @@ "type": "string" }, "subscriptionId": { -"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one.", +"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error.", "location": "query", "type": "string" } @@ -409,7 +409,7 @@ "type": "string" }, "subscriptionId": { -"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one.", +"description": "Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription with the same ID already exists, the creation fails with an `ALREADY_EXISTS` error.", "location": "query", "type": "string" } @@ -586,7 +586,7 @@ } } }, -"revision": "20251113", +"revision": "20260111", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v3.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v3.json new file mode 100644 index 0000000000..59233892ab --- /dev/null +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v3.json @@ -0,0 +1,1189 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://policytroubleshooter.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Policy Troubleshooter", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/", +"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": "policytroubleshooter:v3", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://policytroubleshooter.mtls.googleapis.com/", +"name": "policytroubleshooter", +"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": { +"iam": { +"methods": { +"troubleshoot": { +"description": "Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.", +"flatPath": "v3/iam:troubleshoot", +"httpMethod": "POST", +"id": "policytroubleshooter.iam.troubleshoot", +"parameterOrder": [], +"parameters": {}, +"path": "v3/iam:troubleshoot", +"request": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyRequest" +}, +"response": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +}, +"revision": "20260111", +"rootUrl": "https://policytroubleshooter.googleapis.com/", +"schemas": { +"GoogleCloudPolicytroubleshooterIamV3AccessTuple": { +"description": "Information about the principal, resource, and permission to check.", +"id": "GoogleCloudPolicytroubleshooterIamV3AccessTuple", +"properties": { +"conditionContext": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionContext", +"description": "Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules." +}, +"fullResourceName": { +"description": "Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"permission": { +"description": "Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", +"type": "string" +}, +"permissionFqdn": { +"description": "Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.", +"readOnly": true, +"type": "string" +}, +"principal": { +"description": "Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanation": { +"description": "Details about how a role binding in an allow policy affects a principal's ability to use a permission.", +"id": "GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanation", +"properties": { +"allowAccessState": { +"description": "Required. Indicates whether _this role binding_ gives the specified permission to the specified principal on the specified resource. This field does _not_ indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"combinedMembership": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanationAnnotatedAllowMembership", +"description": "The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly." +}, +"condition": { +"$ref": "GoogleTypeExpr", +"description": "A condition expression that specifies when the role binding grants access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview." +}, +"conditionExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionExplanation", +"description": "Condition evaluation state for this role binding." +}, +"memberships": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanationAnnotatedAllowMembership" +}, +"description": "Indicates whether each role binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the role binding, and each value indicates whether the principal in the role binding includes the principal in the request. For example, suppose that a role binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first principal in the role binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `NOT_INCLUDED`. For the second principal in the role binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `INCLUDED`.", +"type": "object" +}, +"relevance": { +"description": "The relevance of this role binding to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"role": { +"description": "The role that this role binding grants. For example, `roles/compute.admin`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", +"type": "string" +}, +"rolePermission": { +"description": "Indicates whether the role granted by this role binding contains the specified permission.", +"enum": [ +"ROLE_PERMISSION_INCLUSION_STATE_UNSPECIFIED", +"ROLE_PERMISSION_INCLUDED", +"ROLE_PERMISSION_NOT_INCLUDED", +"ROLE_PERMISSION_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The permission is included in the role.", +"The permission is not included in the role.", +"The sender of the request is not allowed to access the role definition." +], +"type": "string" +}, +"rolePermissionRelevance": { +"description": "The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanationAnnotatedAllowMembership": { +"description": "Details about whether the role binding includes the principal.", +"id": "GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanationAnnotatedAllowMembership", +"properties": { +"membership": { +"description": "Indicates whether the role binding includes the principal.", +"enum": [ +"MEMBERSHIP_MATCHING_STATE_UNSPECIFIED", +"MEMBERSHIP_MATCHED", +"MEMBERSHIP_NOT_MATCHED", +"MEMBERSHIP_UNKNOWN_INFO", +"MEMBERSHIP_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"Not specified.", +"The principal in the request matches the principal in the policy. The principal can be included directly or indirectly: * A principal is included directly if that principal is listed in the role binding. * A principal is included indirectly if that principal is in a Google group, Google Workspace account, or Cloud Identity domain that is listed in the policy.", +"The principal in the request doesn't match the principal in the policy.", +"The principal in the policy is a group or domain, and the sender of the request doesn't have permission to view whether the principal in the request is a member of the group or domain.", +"The principal is an unsupported type." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the principal's status to the overall determination for the role binding.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3AllowPolicyExplanation": { +"description": "Details about how the relevant IAM allow policies affect the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3AllowPolicyExplanation", +"properties": { +"allowAccessState": { +"description": "Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedPolicies": { +"description": "List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ExplainedAllowPolicy" +}, +"type": "array" +}, +"relevance": { +"description": "The relevance of the allow policy type to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionContext": { +"description": "Additional context for troubleshooting conditional role bindings and deny rules.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionContext", +"properties": { +"destination": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionContextPeer", +"description": "The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop." +}, +"effectiveTags": { +"description": "Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionContextEffectiveTag" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionContextRequest", +"description": "Represents a network request, such as an HTTP request." +}, +"resource": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionContextResource", +"description": "Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one." +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionContextEffectiveTag": { +"description": "A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionContextEffectiveTag", +"properties": { +"inherited": { +"description": "Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.", +"readOnly": true, +"type": "boolean" +}, +"namespacedTagKey": { +"description": "Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.", +"readOnly": true, +"type": "string" +}, +"namespacedTagValue": { +"description": "Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.", +"readOnly": true, +"type": "string" +}, +"tagKey": { +"description": "Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.", +"readOnly": true, +"type": "string" +}, +"tagKeyParentName": { +"description": "The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`", +"type": "string" +}, +"tagValue": { +"description": "Output only. Resource name for TagValue in the format `tagValues/456`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionContextPeer": { +"description": "This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionContextPeer", +"properties": { +"ip": { +"description": "The IPv4 or IPv6 address of the peer.", +"type": "string" +}, +"port": { +"description": "The network port of the peer.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionContextRequest": { +"description": "This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionContextRequest", +"properties": { +"receiveTime": { +"description": "Optional. The timestamp when the destination service receives the first byte of the request.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionContextResource": { +"description": "Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionContextResource", +"properties": { +"name": { +"description": "The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names", +"type": "string" +}, +"service": { +"description": "The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services", +"type": "string" +}, +"type": { +"description": "The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionExplanation": { +"description": "Explanation for how a condition affects a principal's access", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionExplanation", +"properties": { +"errors": { +"description": "Any errors that prevented complete evaluation of the condition expression.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"evaluationStates": { +"description": "The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionExplanationEvaluationState" +}, +"type": "array" +}, +"value": { +"description": "Value of the condition.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ConditionExplanationEvaluationState": { +"description": "Evaluated state of a condition expression.", +"id": "GoogleCloudPolicytroubleshooterIamV3ConditionExplanationEvaluationState", +"properties": { +"end": { +"description": "End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.", +"format": "int32", +"type": "integer" +}, +"errors": { +"description": "Any errors that prevented complete evaluation of the condition expression.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"start": { +"description": "Start position of an expression in the condition, by character.", +"format": "int32", +"type": "integer" +}, +"value": { +"description": "Value of this expression.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3DenyPolicyExplanation": { +"description": "Details about how the relevant IAM deny policies affect the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3DenyPolicyExplanation", +"properties": { +"denyAccessState": { +"description": "Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedResources": { +"description": "List of resources with IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result. The list of resources includes the policy for the resource itself, as well as policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. The order of the resources starts from the resource and climbs up the resource hierarchy. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ExplainedDenyResource" +}, +"type": "array" +}, +"permissionDeniable": { +"description": "Indicates whether the permission to troubleshoot is supported in deny policies.", +"type": "boolean" +}, +"relevance": { +"description": "The relevance of the deny policy result to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanation": { +"description": "Details about how a deny rule in a deny policy affects a principal's ability to use a permission.", +"id": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanation", +"properties": { +"combinedDeniedPermission": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching", +"description": "Indicates whether the permission in the request is listed as a denied permission in the deny rule." +}, +"combinedDeniedPrincipal": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching", +"description": "Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set." +}, +"combinedExceptionPermission": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching", +"description": "Indicates whether the permission in the request is listed as an exception permission in the deny rule." +}, +"combinedExceptionPrincipal": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching", +"description": "Indicates whether the principal is listed as an exception principal in the deny rule, either directly or through membership in a principal set." +}, +"condition": { +"$ref": "GoogleTypeExpr", +"description": "A condition expression that specifies when the deny rule denies the principal access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview." +}, +"conditionExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ConditionExplanation", +"description": "Condition evaluation state for this role binding." +}, +"deniedPermissions": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching" +}, +"description": "Lists all denied permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a denied permission in the rule, and each value indicates whether the denied permission matches the permission in the request.", +"type": "object" +}, +"deniedPrincipals": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching" +}, +"description": "Lists all denied principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a denied principal in the rule, and each value indicates whether the denied principal matches the principal in the request.", +"type": "object" +}, +"denyAccessState": { +"description": "Required. Indicates whether _this rule_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal is actually denied on the permission for the resource. There might be another rule that overrides this rule. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"exceptionPermissions": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching" +}, +"description": "Lists all exception permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a exception permission in the rule, and each value indicates whether the exception permission matches the permission in the request.", +"type": "object" +}, +"exceptionPrincipals": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching" +}, +"description": "Lists all exception principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a exception principal in the rule, and each value indicates whether the exception principal matches the principal in the request.", +"type": "object" +}, +"relevance": { +"description": "The relevance of this role binding to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching": { +"description": "Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.", +"id": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedDenyPrincipalMatching", +"properties": { +"membership": { +"description": "Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.", +"enum": [ +"MEMBERSHIP_MATCHING_STATE_UNSPECIFIED", +"MEMBERSHIP_MATCHED", +"MEMBERSHIP_NOT_MATCHED", +"MEMBERSHIP_UNKNOWN_INFO", +"MEMBERSHIP_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"Not specified.", +"The principal in the request matches the principal in the policy. The principal can be included directly or indirectly: * A principal is included directly if that principal is listed in the role binding. * A principal is included indirectly if that principal is in a Google group, Google Workspace account, or Cloud Identity domain that is listed in the policy.", +"The principal in the request doesn't match the principal in the policy.", +"The principal in the policy is a group or domain, and the sender of the request doesn't have permission to view whether the principal in the request is a member of the group or domain.", +"The principal is an unsupported type." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the principal's status to the overall determination for the role binding.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching": { +"description": "Details about whether the permission in the request is denied by the deny rule.", +"id": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanationAnnotatedPermissionMatching", +"properties": { +"permissionMatchingState": { +"description": "Indicates whether the permission in the request is denied by the deny rule.", +"enum": [ +"PERMISSION_PATTERN_MATCHING_STATE_UNSPECIFIED", +"PERMISSION_PATTERN_MATCHED", +"PERMISSION_PATTERN_NOT_MATCHED" +], +"enumDescriptions": [ +"Not specified.", +"The permission in the request matches the permission in the policy.", +"The permission in the request matches the permission in the policy." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the permission status to the overall determination for the rule.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ExplainedAllowPolicy": { +"description": "Details about how a specific IAM allow policy contributed to the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3ExplainedAllowPolicy", +"properties": { +"allowAccessState": { +"description": "Required. Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"bindingExplanations": { +"description": "Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy. If the sender of the request does not have access to the policy, this field is omitted.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AllowBindingExplanation" +}, +"type": "array" +}, +"fullResourceName": { +"description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"policy": { +"$ref": "GoogleIamV1Policy", +"description": "The IAM allow policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty." +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ExplainedDenyPolicy": { +"description": "Details about how a specific IAM deny policy Policy contributed to the access check.", +"id": "GoogleCloudPolicytroubleshooterIamV3ExplainedDenyPolicy", +"properties": { +"denyAccessState": { +"description": "Required. Indicates whether _this policy_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"policy": { +"$ref": "GoogleIamV2Policy", +"description": "The IAM deny policy attached to the resource. If the sender of the request does not have access to the policy, this field is omitted." +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"ruleExplanations": { +"description": "Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy. If the sender of the request does not have access to the policy, this field is omitted.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyRuleExplanation" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3ExplainedDenyResource": { +"description": "Details about how a specific resource contributed to the deny policy evaluation.", +"id": "GoogleCloudPolicytroubleshooterIamV3ExplainedDenyResource", +"properties": { +"denyAccessState": { +"description": "Required. Indicates whether any policies attached to _this resource_ deny the specific permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedPolicies": { +"description": "List of IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3ExplainedDenyPolicy" +}, +"type": "array" +}, +"fullResourceName": { +"description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyRequest": { +"description": "Request for TroubleshootIamPolicy.", +"id": "GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyRequest", +"properties": { +"accessTuple": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AccessTuple", +"description": "The information to use for checking whether a principal has a permission for a resource." +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyResponse": { +"description": "Response for TroubleshootIamPolicy.", +"id": "GoogleCloudPolicytroubleshooterIamV3TroubleshootIamPolicyResponse", +"properties": { +"accessTuple": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AccessTuple", +"description": "The access tuple from the request, including any provided context used to evaluate the condition." +}, +"allowPolicyExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3AllowPolicyExplanation", +"description": "An explanation of how the applicable IAM allow policies affect the final access state." +}, +"denyPolicyExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3DenyPolicyExplanation", +"description": "An explanation of how the applicable IAM deny policies affect the final access state." +}, +"overallAccessState": { +"description": "Indicates whether the principal has the specified permission for the specified resource, based on evaluating all types of the applicable IAM policies.", +"enum": [ +"OVERALL_ACCESS_STATE_UNSPECIFIED", +"CAN_ACCESS", +"CANNOT_ACCESS", +"UNKNOWN_INFO", +"UNKNOWN_CONDITIONAL" +], +"enumDescriptions": [ +"Not specified.", +"The principal has the permission.", +"The principal doesn't have the permission.", +"The principal might have the permission, but the sender can't access all of the information needed to fully evaluate the principal's access.", +"The principal might have the permission, but Policy Troubleshooter can't fully evaluate the principal's access because the sender didn't provide the required context to evaluate the condition." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1AuditConfig": { +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", +"id": "GoogleIamV1AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "GoogleIamV1AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "GoogleIamV1AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "GoogleIamV1Binding", +"properties": { +"condition": { +"$ref": "GoogleTypeExpr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "GoogleIamV1Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "GoogleIamV1AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "GoogleIamV1Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleIamV2DenyRule": { +"description": "A deny rule in an IAM deny policy.", +"id": "GoogleIamV2DenyRule", +"properties": { +"denialCondition": { +"$ref": "GoogleTypeExpr", +"description": "The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to `true`, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate [resource tags](https://cloud.google.com/iam/help/conditions/resource-tags). Other functions and operators are not supported." +}, +"deniedPermissions": { +"description": "The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"deniedPrincipals": { +"description": " The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"exceptionPermissions": { +"description": "Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"exceptionPrincipals": { +"description": "The identities that are excluded from the deny rule, even if they are listed in the `denied_principals`. For example, you could add a Google group to the `denied_principals`, then exclude specific users who belong to that group. This field can contain the same values as the `denied_principals` field, excluding `principalSet://goog/public:all`, which represents all users on the internet.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleIamV2Policy": { +"description": "Data for an IAM policy.", +"id": "GoogleIamV2Policy", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters.", +"type": "object" +}, +"createTime": { +"description": "Output only. The time when the `Policy` was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleteTime": { +"description": "Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "A user-specified description of the `Policy`. This value can be up to 63 characters.", +"type": "string" +}, +"etag": { +"description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.", +"type": "string" +}, +"kind": { +"description": "Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.", +"type": "string" +}, +"rules": { +"description": "A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`.", +"items": { +"$ref": "GoogleIamV2PolicyRule" +}, +"type": "array" +}, +"uid": { +"description": "Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the `Policy` was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV2PolicyRule": { +"description": "A single rule in a `Policy`.", +"id": "GoogleIamV2PolicyRule", +"properties": { +"denyRule": { +"$ref": "GoogleIamV2DenyRule", +"description": "A rule for a deny policy." +}, +"description": { +"description": "A user-specified description of the rule. This value can be up to 256 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleRpcStatus": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "GoogleRpcStatus", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleTypeExpr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "GoogleTypeExpr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Policy Troubleshooter API", +"version": "v3", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v3beta.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v3beta.json new file mode 100644 index 0000000000..2fc8bb7f27 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v3beta.json @@ -0,0 +1,1722 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://policytroubleshooter.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Policy Troubleshooter", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/iam/", +"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": "policytroubleshooter:v3beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://policytroubleshooter.mtls.googleapis.com/", +"name": "policytroubleshooter", +"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": { +"iam": { +"methods": { +"troubleshoot": { +"description": "Checks whether a principal has a specific permission for a specific resource, and explains why the principal does or doesn't have that permission.", +"flatPath": "v3beta/iam:troubleshoot", +"httpMethod": "POST", +"id": "policytroubleshooter.iam.troubleshoot", +"parameterOrder": [], +"parameters": {}, +"path": "v3beta/iam:troubleshoot", +"request": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyRequest" +}, +"response": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +}, +"revision": "20260111", +"rootUrl": "https://policytroubleshooter.googleapis.com/", +"schemas": { +"GoogleCloudPolicytroubleshooterIamV3betaAccessTuple": { +"description": "Information about the principal, resource, and permission to check.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaAccessTuple", +"properties": { +"conditionContext": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionContext", +"description": "Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules." +}, +"fullResourceName": { +"description": "Required. The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"permission": { +"description": "Required. The IAM permission to check for, either in the `v1` permission format or the `v2` permission format. For a complete list of IAM permissions in the `v1` format, see https://cloud.google.com/iam/help/permissions/reference. For a list of IAM permissions in the `v2` format, see https://cloud.google.com/iam/help/deny/supported-permissions. For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", +"type": "string" +}, +"permissionFqdn": { +"description": "Output only. The permission that Policy Troubleshooter checked for, in the `v2` format.", +"readOnly": true, +"type": "string" +}, +"principal": { +"description": "Required. The email address of the principal whose access you want to check. For example, `alice@example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The principal must be a Google Account or a service account. Other types of principals are not supported.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanation": { +"description": "Details about how a role binding in an allow policy affects a principal's ability to use a permission.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanation", +"properties": { +"allowAccessState": { +"description": "Required. Indicates whether _this role binding_ gives the specified permission to the specified principal on the specified resource. This field does _not_ indicate whether the principal actually has the permission on the resource. There might be another role binding that overrides this role binding. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"combinedMembership": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanationAnnotatedAllowMembership", +"description": "The combined result of all memberships. Indicates if the principal is included in any role binding, either directly or indirectly." +}, +"condition": { +"$ref": "GoogleTypeExpr", +"description": "A condition expression that specifies when the role binding grants access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview." +}, +"conditionExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanation", +"description": "Condition evaluation state for this role binding." +}, +"memberships": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanationAnnotatedAllowMembership" +}, +"description": "Indicates whether each role binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the role binding, and each value indicates whether the principal in the role binding includes the principal in the request. For example, suppose that a role binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` You want to troubleshoot access for `user:bob@example.com`. This user is a member of the group `group:product-eng@example.com`. For the first principal in the role binding, the key is `user:alice@example.com`, and the `membership` field in the value is set to `NOT_INCLUDED`. For the second principal in the role binding, the key is `group:product-eng@example.com`, and the `membership` field in the value is set to `INCLUDED`.", +"type": "object" +}, +"relevance": { +"description": "The relevance of this role binding to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"role": { +"description": "The role that this role binding grants. For example, `roles/compute.admin`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.", +"type": "string" +}, +"rolePermission": { +"description": "Indicates whether the role granted by this role binding contains the specified permission.", +"enum": [ +"ROLE_PERMISSION_INCLUSION_STATE_UNSPECIFIED", +"ROLE_PERMISSION_INCLUDED", +"ROLE_PERMISSION_NOT_INCLUDED", +"ROLE_PERMISSION_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The permission is included in the role.", +"The permission is not included in the role.", +"The sender of the request is not allowed to access the role definition." +], +"type": "string" +}, +"rolePermissionRelevance": { +"description": "The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanationAnnotatedAllowMembership": { +"description": "Details about whether the role binding includes the principal.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanationAnnotatedAllowMembership", +"properties": { +"membership": { +"description": "Indicates whether the role binding includes the principal.", +"enum": [ +"MEMBERSHIP_MATCHING_STATE_UNSPECIFIED", +"MEMBERSHIP_MATCHED", +"MEMBERSHIP_NOT_MATCHED", +"MEMBERSHIP_UNKNOWN_INFO", +"MEMBERSHIP_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"Not specified.", +"The principal in the request matches the principal in the policy. The principal can be included directly or indirectly: * A principal is included directly if that principal is listed in the role binding. * A principal is included indirectly if that principal is in a Google group, Google Workspace account, or Cloud Identity domain that is listed in the policy.", +"The principal in the request doesn't match the principal in the policy.", +"The principal in the policy is a group or domain, and the sender of the request doesn't have permission to view whether the principal in the request is a member of the group or domain.", +"The principal is an unsupported type." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the principal's status to the overall determination for the role binding.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaAllowPolicyExplanation": { +"description": "Details about how the relevant IAM allow policies affect the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaAllowPolicyExplanation", +"properties": { +"allowAccessState": { +"description": "Indicates whether the principal has the specified permission for the specified resource, based on evaluating all applicable IAM allow policies.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedPolicies": { +"description": "List of IAM allow policies that were evaluated to check the principal's permissions, with annotations to indicate how each policy contributed to the final result. The list of policies includes the policy for the resource itself, as well as allow policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedAllowPolicy" +}, +"type": "array" +}, +"relevance": { +"description": "The relevance of the allow policy type to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionContext": { +"description": "Additional context for troubleshooting conditional role bindings and deny rules.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionContext", +"properties": { +"destination": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextPeer", +"description": "The destination of a network activity, such as accepting a TCP connection. In a multi-hop network activity, the destination represents the receiver of the last hop." +}, +"effectiveTags": { +"description": "Output only. The effective tags on the resource. The effective tags are fetched during troubleshooting.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextEffectiveTag" +}, +"readOnly": true, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextRequest", +"description": "Represents a network request, such as an HTTP request." +}, +"resource": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextResource", +"description": "Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one." +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionContextEffectiveTag": { +"description": "A tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. `EffectiveTag` contains the `name` and `namespaced_name` of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextEffectiveTag", +"properties": { +"inherited": { +"description": "Output only. Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.", +"readOnly": true, +"type": "boolean" +}, +"namespacedTagKey": { +"description": "Output only. The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`.", +"readOnly": true, +"type": "string" +}, +"namespacedTagValue": { +"description": "Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`.", +"readOnly": true, +"type": "string" +}, +"tagKey": { +"description": "Output only. The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.", +"readOnly": true, +"type": "string" +}, +"tagKeyParentName": { +"description": "The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}`", +"type": "string" +}, +"tagValue": { +"description": "Output only. Resource name for TagValue in the format `tagValues/456`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionContextPeer": { +"description": "This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextPeer", +"properties": { +"ip": { +"description": "The IPv4 or IPv6 address of the peer.", +"type": "string" +}, +"port": { +"description": "The network port of the peer.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionContextRequest": { +"description": "This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextRequest", +"properties": { +"receiveTime": { +"description": "Optional. The timestamp when the destination service receives the first byte of the request.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionContextResource": { +"description": "Core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a Compute Engine instance.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionContextResource", +"properties": { +"name": { +"description": "The stable identifier (name) of a resource on the `service`. A resource can be logically identified as `//{resource.service}/{resource.name}`. Unlike the resource URI, the resource name doesn't contain any protocol and version information. For a list of full resource name formats, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names", +"type": "string" +}, +"service": { +"description": "The name of the service that this resource belongs to, such as `compute.googleapis.com`. The service name might not match the DNS hostname that actually serves the request. For a full list of resource service values, see https://cloud.google.com/iam/help/conditions/resource-services", +"type": "string" +}, +"type": { +"description": "The type of the resource, in the format `{service}/{kind}`. For a full list of resource type values, see https://cloud.google.com/iam/help/conditions/resource-types", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionExplanation": { +"description": "Explanation for how a condition affects a principal's access", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanation", +"properties": { +"errors": { +"description": "Any errors that prevented complete evaluation of the condition expression.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"evaluationStates": { +"description": "The value of each statement of the condition expression. The value can be `true`, `false`, or `null`. The value is `null` if the statement can't be evaluated.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanationEvaluationState" +}, +"type": "array" +}, +"value": { +"description": "Value of the condition.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaConditionExplanationEvaluationState": { +"description": "Evaluated state of a condition expression.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanationEvaluationState", +"properties": { +"end": { +"description": "End position of an expression in the condition, by character, end included, for example: the end position of the first part of `a==b || c==d` would be 4.", +"format": "int32", +"type": "integer" +}, +"errors": { +"description": "Any errors that prevented complete evaluation of the condition expression.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"start": { +"description": "Start position of an expression in the condition, by character.", +"format": "int32", +"type": "integer" +}, +"value": { +"description": "Value of this expression.", +"type": "any" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaDenyPolicyExplanation": { +"description": "Details about how the relevant IAM deny policies affect the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaDenyPolicyExplanation", +"properties": { +"denyAccessState": { +"description": "Indicates whether the principal is denied the specified permission for the specified resource, based on evaluating all applicable IAM deny policies.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedResources": { +"description": "List of resources with IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result. The list of resources includes the policy for the resource itself, as well as policies that are inherited from higher levels of the resource hierarchy, including the organization, the folder, and the project. The order of the resources starts from the resource and climbs up the resource hierarchy. To learn more about the resource hierarchy, see https://cloud.google.com/iam/help/resource-hierarchy.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyResource" +}, +"type": "array" +}, +"permissionDeniable": { +"description": "Indicates whether the permission to troubleshoot is supported in deny policies.", +"type": "boolean" +}, +"relevance": { +"description": "The relevance of the deny policy result to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanation": { +"description": "Details about how a deny rule in a deny policy affects a principal's ability to use a permission.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanation", +"properties": { +"combinedDeniedPermission": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching", +"description": "Indicates whether the permission in the request is listed as a denied permission in the deny rule." +}, +"combinedDeniedPrincipal": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching", +"description": "Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set." +}, +"combinedExceptionPermission": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching", +"description": "Indicates whether the permission in the request is listed as an exception permission in the deny rule." +}, +"combinedExceptionPrincipal": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching", +"description": "Indicates whether the principal is listed as an exception principal in the deny rule, either directly or through membership in a principal set." +}, +"condition": { +"$ref": "GoogleTypeExpr", +"description": "A condition expression that specifies when the deny rule denies the principal access. To learn about IAM Conditions, see https://cloud.google.com/iam/help/conditions/overview." +}, +"conditionExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanation", +"description": "Condition evaluation state for this role binding." +}, +"deniedPermissions": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching" +}, +"description": "Lists all denied permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a denied permission in the rule, and each value indicates whether the denied permission matches the permission in the request.", +"type": "object" +}, +"deniedPrincipals": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching" +}, +"description": "Lists all denied principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a denied principal in the rule, and each value indicates whether the denied principal matches the principal in the request.", +"type": "object" +}, +"denyAccessState": { +"description": "Required. Indicates whether _this rule_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal is actually denied on the permission for the resource. There might be another rule that overrides this rule. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"exceptionPermissions": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching" +}, +"description": "Lists all exception permissions in the deny rule and indicates whether each permission matches the permission in the request. Each key identifies a exception permission in the rule, and each value indicates whether the exception permission matches the permission in the request.", +"type": "object" +}, +"exceptionPrincipals": { +"additionalProperties": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching" +}, +"description": "Lists all exception principals in the deny rule and indicates whether each principal matches the principal in the request, either directly or through membership in a principal set. Each key identifies a exception principal in the rule, and each value indicates whether the exception principal matches the principal in the request.", +"type": "object" +}, +"relevance": { +"description": "The relevance of this role binding to the overall determination for the entire policy.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching": { +"description": "Details about whether the principal in the request is listed as a denied principal in the deny rule, either directly or through membership in a principal set.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedDenyPrincipalMatching", +"properties": { +"membership": { +"description": "Indicates whether the principal is listed as a denied principal in the deny rule, either directly or through membership in a principal set.", +"enum": [ +"MEMBERSHIP_MATCHING_STATE_UNSPECIFIED", +"MEMBERSHIP_MATCHED", +"MEMBERSHIP_NOT_MATCHED", +"MEMBERSHIP_UNKNOWN_INFO", +"MEMBERSHIP_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"Not specified.", +"The principal in the request matches the principal in the policy. The principal can be included directly or indirectly: * A principal is included directly if that principal is listed in the role binding. * A principal is included indirectly if that principal is in a Google group, Google Workspace account, or Cloud Identity domain that is listed in the policy.", +"The principal in the request doesn't match the principal in the policy.", +"The principal in the policy is a group or domain, and the sender of the request doesn't have permission to view whether the principal in the request is a member of the group or domain.", +"The principal is an unsupported type." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the principal's status to the overall determination for the role binding.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching": { +"description": "Details about whether the permission in the request is denied by the deny rule.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanationAnnotatedPermissionMatching", +"properties": { +"permissionMatchingState": { +"description": "Indicates whether the permission in the request is denied by the deny rule.", +"enum": [ +"PERMISSION_PATTERN_MATCHING_STATE_UNSPECIFIED", +"PERMISSION_PATTERN_MATCHED", +"PERMISSION_PATTERN_NOT_MATCHED" +], +"enumDescriptions": [ +"Not specified.", +"The permission in the request matches the permission in the policy.", +"The permission in the request matches the permission in the policy." +], +"type": "string" +}, +"relevance": { +"description": "The relevance of the permission status to the overall determination for the rule.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedAllowPolicy": { +"description": "Details about how a specific IAM allow policy contributed to the final access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedAllowPolicy", +"properties": { +"allowAccessState": { +"description": "Required. Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"ALLOW_ACCESS_STATE_UNSPECIFIED", +"ALLOW_ACCESS_STATE_GRANTED", +"ALLOW_ACCESS_STATE_NOT_GRANTED", +"ALLOW_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"ALLOW_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The allow policy gives the principal the permission.", +"The allow policy doesn't give the principal the permission.", +"The allow policy gives the principal the permission if a condition expression evaluate to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request doesn't have access to all of the allow policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"bindingExplanations": { +"description": "Details about how each role binding in the policy affects the principal's ability, or inability, to use the permission for the resource. The order of the role bindings matches the role binding order in the policy. If the sender of the request does not have access to the policy, this field is omitted.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAllowBindingExplanation" +}, +"type": "array" +}, +"fullResourceName": { +"description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"policy": { +"$ref": "GoogleIamV1Policy", +"description": "The IAM allow policy attached to the resource. If the sender of the request does not have access to the policy, this field is empty." +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyPolicy": { +"description": "Details about how a specific IAM deny policy Policy contributed to the access check.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyPolicy", +"properties": { +"denyAccessState": { +"description": "Required. Indicates whether _this policy_ denies the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"policy": { +"$ref": "GoogleIamV2Policy", +"description": "The IAM deny policy attached to the resource. If the sender of the request does not have access to the policy, this field is omitted." +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"ruleExplanations": { +"description": "Details about how each rule in the policy affects the principal's inability to use the permission for the resource. The order of the deny rule matches the order of the rules in the deny policy. If the sender of the request does not have access to the policy, this field is omitted.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyRuleExplanation" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyResource": { +"description": "Details about how a specific resource contributed to the deny policy evaluation.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyResource", +"properties": { +"denyAccessState": { +"description": "Required. Indicates whether any policies attached to _this resource_ deny the specific permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another policy that overrides this policy. To determine whether the principal actually has the permission, use the `overall_access_state` field in the TroubleshootIamPolicyResponse.", +"enum": [ +"DENY_ACCESS_STATE_UNSPECIFIED", +"DENY_ACCESS_STATE_DENIED", +"DENY_ACCESS_STATE_NOT_DENIED", +"DENY_ACCESS_STATE_UNKNOWN_CONDITIONAL", +"DENY_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The deny policy denies the principal the permission.", +"The deny policy doesn't deny the principal the permission.", +"The deny policy denies the principal the permission if a condition expression evaluates to `true`. However, the sender of the request didn't provide enough context for Policy Troubleshooter to evaluate the condition expression.", +"The sender of the request does not have access to all of the deny policies that Policy Troubleshooter needs to evaluate the principal's access." +], +"type": "string" +}, +"explainedPolicies": { +"description": "List of IAM deny policies that were evaluated to check the principal's denied permissions, with annotations to indicate how each policy contributed to the final result.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedDenyPolicy" +}, +"type": "array" +}, +"fullResourceName": { +"description": "The full resource name that identifies the resource. For example, `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. If the sender of the request does not have access to the policy, this field is omitted. For examples of full resource names for Google Cloud services, see https://cloud.google.com/iam/help/troubleshooter/full-resource-names.", +"type": "string" +}, +"relevance": { +"description": "The relevance of this policy to the overall access state in the TroubleshootIamPolicyResponse. If the sender of the request does not have access to the policy, this field is omitted.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPABBindingAndPolicy": { +"description": "Details about how a principal access boundary binding and policy contributes to the principal access boundary explanation, with annotations to indicate how the binding and policy contribute to the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABBindingAndPolicy", +"properties": { +"bindingAndPolicyAccessState": { +"description": "Output only. Indicates whether the principal is allowed to access the specified resource based on evaluating the binding and policy.", +"enum": [ +"PAB_ACCESS_STATE_UNSPECIFIED", +"PAB_ACCESS_STATE_ALLOWED", +"PAB_ACCESS_STATE_NOT_ALLOWED", +"PAB_ACCESS_STATE_NOT_ENFORCED", +"PAB_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The PAB component allows the principal's access to the specified resource.", +"The PAB component doesn't allow the principal's access to the specified resource.", +"The PAB component is not enforced on the principal, or the specified resource. This state refers to the following scenarios: - IAM doesn't enforce the specified permission at the PAB policy's [enforcement version](https://cloud.google.com/iam/help/pab/enforcement-versions), so the PAB policy can't block access. - The binding doesn't apply to the principal, so the policy is not enforced. - The PAB policy doesn't have any rules", +"The sender of the request does not have access to the PAB component, or the relevant data to explain the PAB component." +], +"readOnly": true, +"type": "string" +}, +"explainedPolicy": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicy", +"description": "Optional. Details about how this policy contributes to the principal access boundary explanation, with annotations to indicate how the policy contributes to the overall access state. If the caller doesn't have permission to view the policy in the binding, this field is omitted." +}, +"explainedPolicyBinding": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPolicyBinding", +"description": "Details about how this binding contributes to the principal access boundary explanation, with annotations to indicate how the binding contributes to the overall access state." +}, +"relevance": { +"description": "The relevance of this principal access boundary binding and policy to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicy": { +"description": "Details about how a principal access boundary policy contributes to the explanation, with annotations to indicate how the policy contributes to the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicy", +"properties": { +"explainedRules": { +"description": "List of principal access boundary rules that were explained to check the principal's access to specified resource, with annotations to indicate how each rule contributes to the overall access state.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRule" +}, +"type": "array" +}, +"policy": { +"$ref": "GoogleIamV3PrincipalAccessBoundaryPolicy", +"description": "The policy that is explained." +}, +"policyAccessState": { +"description": "Output only. Indicates whether the policy allows access to the specified resource.", +"enum": [ +"PAB_ACCESS_STATE_UNSPECIFIED", +"PAB_ACCESS_STATE_ALLOWED", +"PAB_ACCESS_STATE_NOT_ALLOWED", +"PAB_ACCESS_STATE_NOT_ENFORCED", +"PAB_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The PAB component allows the principal's access to the specified resource.", +"The PAB component doesn't allow the principal's access to the specified resource.", +"The PAB component is not enforced on the principal, or the specified resource. This state refers to the following scenarios: - IAM doesn't enforce the specified permission at the PAB policy's [enforcement version](https://cloud.google.com/iam/help/pab/enforcement-versions), so the PAB policy can't block access. - The binding doesn't apply to the principal, so the policy is not enforced. - The PAB policy doesn't have any rules", +"The sender of the request does not have access to the PAB component, or the relevant data to explain the PAB component." +], +"readOnly": true, +"type": "string" +}, +"policyVersion": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicyVersion", +"description": "Output only. Explanation of the principal access boundary policy's version.", +"readOnly": true +}, +"relevance": { +"description": "The relevance of this policy to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicyVersion": { +"description": "Details about how a principal access boundary policy's version contributes to the policy's enforcement state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABPolicyVersion", +"properties": { +"enforcementState": { +"description": "Output only. Indicates whether the policy is enforced based on its version.", +"enum": [ +"PAB_POLICY_ENFORCEMENT_STATE_UNSPECIFIED", +"PAB_POLICY_ENFORCEMENT_STATE_ENFORCED", +"PAB_POLICY_ENFORCEMENT_STATE_NOT_ENFORCED" +], +"enumDescriptions": [ +"An error occurred when checking whether a principal access boundary policy is enforced based on its version.", +"The principal access boundary policy is enforced based on its version.", +"The principal access boundary policy is not enforced based on its version." +], +"readOnly": true, +"type": "string" +}, +"version": { +"description": "Output only. The actual version of the policy. - If the policy uses static version, this field is the chosen static version. - If the policy uses dynamic version, this field is the effective latest version.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRule": { +"description": "Details about how a principal access boundary rule contributes to the explanation, with annotations to indicate how the rule contributes to the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRule", +"properties": { +"combinedResourceInclusionState": { +"description": "Output only. Indicates whether any resource of the rule is the specified resource or includes the specified resource.", +"enum": [ +"RESOURCE_INCLUSION_STATE_UNSPECIFIED", +"RESOURCE_INCLUSION_STATE_INCLUDED", +"RESOURCE_INCLUSION_STATE_NOT_INCLUDED", +"RESOURCE_INCLUSION_STATE_UNKNOWN_INFO", +"RESOURCE_INCLUSION_STATE_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"An error occurred when checking whether the resource includes the specified resource.", +"The resource includes the specified resource.", +"The resource doesn't include the specified resource.", +"The sender of the request does not have access to the relevant data to check whether the resource includes the specified resource.", +"The resource is of an unsupported type, such as non-CRM resources." +], +"readOnly": true, +"type": "string" +}, +"effect": { +"description": "Required. The effect of the rule which describes the access relationship.", +"enum": [ +"EFFECT_UNSPECIFIED", +"ALLOW" +], +"enumDescriptions": [ +"Effect unspecified.", +"Allows access to the resources in this rule." +], +"type": "string" +}, +"explainedResources": { +"description": "List of resources that were explained to check the principal's access to specified resource, with annotations to indicate how each resource contributes to the overall access state.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRuleExplainedResource" +}, +"type": "array" +}, +"relevance": { +"description": "The relevance of this rule to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"ruleAccessState": { +"description": "Output only. Indicates whether the rule allows access to the specified resource.", +"enum": [ +"PAB_ACCESS_STATE_UNSPECIFIED", +"PAB_ACCESS_STATE_ALLOWED", +"PAB_ACCESS_STATE_NOT_ALLOWED", +"PAB_ACCESS_STATE_NOT_ENFORCED", +"PAB_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The PAB component allows the principal's access to the specified resource.", +"The PAB component doesn't allow the principal's access to the specified resource.", +"The PAB component is not enforced on the principal, or the specified resource. This state refers to the following scenarios: - IAM doesn't enforce the specified permission at the PAB policy's [enforcement version](https://cloud.google.com/iam/help/pab/enforcement-versions), so the PAB policy can't block access. - The binding doesn't apply to the principal, so the policy is not enforced. - The PAB policy doesn't have any rules", +"The sender of the request does not have access to the PAB component, or the relevant data to explain the PAB component." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRuleExplainedResource": { +"description": "Details about how a resource contributes to the explanation, with annotations to indicate how the resource contributes to the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABRuleExplainedResource", +"properties": { +"relevance": { +"description": "The relevance of this resource to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +}, +"resource": { +"description": "The [full resource name](https://cloud.google.com/iam/docs/full-resource-names) that identifies the resource that is explained. This can only be a project, a folder, or an organization which is what a PAB rule accepts.", +"type": "string" +}, +"resourceInclusionState": { +"description": "Output only. Indicates whether the resource is the specified resource or includes the specified resource.", +"enum": [ +"RESOURCE_INCLUSION_STATE_UNSPECIFIED", +"RESOURCE_INCLUSION_STATE_INCLUDED", +"RESOURCE_INCLUSION_STATE_NOT_INCLUDED", +"RESOURCE_INCLUSION_STATE_UNKNOWN_INFO", +"RESOURCE_INCLUSION_STATE_UNKNOWN_UNSUPPORTED" +], +"enumDescriptions": [ +"An error occurred when checking whether the resource includes the specified resource.", +"The resource includes the specified resource.", +"The resource doesn't include the specified resource.", +"The sender of the request does not have access to the relevant data to check whether the resource includes the specified resource.", +"The resource is of an unsupported type, such as non-CRM resources." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaExplainedPolicyBinding": { +"description": "Details about how a policy binding contributes to the policy explanation, with annotations to indicate how the policy binding contributes to the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPolicyBinding", +"properties": { +"conditionExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaConditionExplanation", +"description": "Optional. Explanation of the condition in the policy binding. If the policy binding doesn't have a condition, this field is omitted." +}, +"policyBinding": { +"$ref": "GoogleIamV3PolicyBinding", +"description": "The policy binding that is explained." +}, +"policyBindingState": { +"description": "Output only. Indicates whether the policy binding takes effect.", +"enum": [ +"POLICY_BINDING_STATE_UNSPECIFIED", +"POLICY_BINDING_STATE_ENFORCED", +"POLICY_BINDING_STATE_NOT_ENFORCED" +], +"enumDescriptions": [ +"An error occurred when checking whether the policy binding is enforced.", +"The policy binding is enforced.", +"The policy binding is not enforced." +], +"readOnly": true, +"type": "string" +}, +"relevance": { +"description": "The relevance of this policy binding to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaPABPolicyExplanation": { +"description": "Details about how the relevant principal access boundary policies affect the overall access state.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaPABPolicyExplanation", +"properties": { +"explainedBindingsAndPolicies": { +"description": "List of principal access boundary policies and bindings that are applicable to the principal's access state, with annotations to indicate how each binding and policy contributes to the overall access state.", +"items": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaExplainedPABBindingAndPolicy" +}, +"type": "array" +}, +"principalAccessBoundaryAccessState": { +"description": "Output only. Indicates whether the principal is allowed to access specified resource, based on evaluating all applicable principal access boundary bindings and policies.", +"enum": [ +"PAB_ACCESS_STATE_UNSPECIFIED", +"PAB_ACCESS_STATE_ALLOWED", +"PAB_ACCESS_STATE_NOT_ALLOWED", +"PAB_ACCESS_STATE_NOT_ENFORCED", +"PAB_ACCESS_STATE_UNKNOWN_INFO" +], +"enumDescriptions": [ +"Not specified.", +"The PAB component allows the principal's access to the specified resource.", +"The PAB component doesn't allow the principal's access to the specified resource.", +"The PAB component is not enforced on the principal, or the specified resource. This state refers to the following scenarios: - IAM doesn't enforce the specified permission at the PAB policy's [enforcement version](https://cloud.google.com/iam/help/pab/enforcement-versions), so the PAB policy can't block access. - The binding doesn't apply to the principal, so the policy is not enforced. - The PAB policy doesn't have any rules", +"The sender of the request does not have access to the PAB component, or the relevant data to explain the PAB component." +], +"readOnly": true, +"type": "string" +}, +"relevance": { +"description": "The relevance of the principal access boundary access state to the overall access state.", +"enum": [ +"HEURISTIC_RELEVANCE_UNSPECIFIED", +"HEURISTIC_RELEVANCE_NORMAL", +"HEURISTIC_RELEVANCE_HIGH" +], +"enumDescriptions": [ +"Not specified.", +"The data point has a limited effect on the result. Changing the data point is unlikely to affect the overall determination.", +"The data point has a strong effect on the result. Changing the data point is likely to affect the overall determination." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyRequest": { +"description": "Request for TroubleshootIamPolicy.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyRequest", +"properties": { +"accessTuple": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAccessTuple", +"description": "The information to use for checking whether a principal has a permission for a resource." +} +}, +"type": "object" +}, +"GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyResponse": { +"description": "Response for TroubleshootIamPolicy.", +"id": "GoogleCloudPolicytroubleshooterIamV3betaTroubleshootIamPolicyResponse", +"properties": { +"accessTuple": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAccessTuple", +"description": "The access tuple from the request, including any provided context used to evaluate the condition." +}, +"allowPolicyExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaAllowPolicyExplanation", +"description": "An explanation of how the applicable IAM allow policies affect the final access state." +}, +"denyPolicyExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaDenyPolicyExplanation", +"description": "An explanation of how the applicable IAM deny policies affect the final access state." +}, +"overallAccessState": { +"description": "Indicates whether the principal has the specified permission for the specified resource, based on evaluating all types of the applicable IAM policies.", +"enum": [ +"OVERALL_ACCESS_STATE_UNSPECIFIED", +"CAN_ACCESS", +"CANNOT_ACCESS", +"UNKNOWN_INFO", +"UNKNOWN_CONDITIONAL" +], +"enumDescriptions": [ +"Not specified.", +"The principal has the permission.", +"The principal doesn't have the permission.", +"The principal might have the permission, but the sender can't access all of the information needed to fully evaluate the principal's access.", +"The principal might have the permission, but Policy Troubleshooter can't fully evaluate the principal's access because the sender didn't provide the required context to evaluate the condition." +], +"type": "string" +}, +"pabPolicyExplanation": { +"$ref": "GoogleCloudPolicytroubleshooterIamV3betaPABPolicyExplanation", +"description": "An explanation of how the applicable principal access boundary policies affect the final access state." +} +}, +"type": "object" +}, +"GoogleIamV1AuditConfig": { +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", +"id": "GoogleIamV1AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "GoogleIamV1AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "GoogleIamV1AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "GoogleIamV1Binding", +"properties": { +"condition": { +"$ref": "GoogleTypeExpr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV1Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "GoogleIamV1Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "GoogleIamV1AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "GoogleIamV1Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleIamV2DenyRule": { +"description": "A deny rule in an IAM deny policy.", +"id": "GoogleIamV2DenyRule", +"properties": { +"denialCondition": { +"$ref": "GoogleTypeExpr", +"description": "The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to `true`, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate [resource tags](https://cloud.google.com/iam/help/conditions/resource-tags). Other functions and operators are not supported." +}, +"deniedPermissions": { +"description": "The permissions that are explicitly denied by this rule. Each permission uses the format `{service_fqdn}/{resource}.{verb}`, where `{service_fqdn}` is the fully qualified domain name for the service. For example, `iam.googleapis.com/roles.list`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"deniedPrincipals": { +"description": " The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values: * `principal://goog/subject/{email_id}`: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, `principal://goog/subject/alice@example.com`. * `principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}`: A Google Cloud service account. For example, `principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com`. * `principalSet://goog/group/{group_id}`: A Google group. For example, `principalSet://goog/group/admins@example.com`. * `principalSet://goog/public:all`: A special identifier that represents any principal that is on the internet, even if they do not have a Google Account or are not logged in. * `principalSet://goog/cloudIdentityCustomerId/{customer_id}`: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, `principalSet://goog/cloudIdentityCustomerId/C01Abc35`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAccount`: All service accounts grouped under a resource (project, folder, or organization). * `principalSet://cloudresourcemanager.googleapis.com/[projects|folders|organizations]/{project_number|folder_number|org_number}/type/ServiceAgent`: All service agents grouped under a resource (project, folder, or organization). * `deleted:principal://goog/subject/{email_id}?uid={uid}`: A specific Google Account that was deleted recently. For example, `deleted:principal://goog/subject/alice@example.com?uid=1234567890`. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account. * `deleted:principalSet://goog/group/{group_id}?uid={uid}`: A Google group that was deleted recently. For example, `deleted:principalSet://goog/group/admins@example.com?uid=1234567890`. If the Google group is restored, this identifier reverts to the standard identifier for a Google group. * `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}`: A Google Cloud service account that was deleted recently. For example, `deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/my-service-account@iam.gserviceaccount.com?uid=1234567890`. If the service account is undeleted, this identifier reverts to the standard identifier for a service account. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"exceptionPermissions": { +"description": "Specifies the permissions that this rule excludes from the set of denied permissions given by `denied_permissions`. If a permission appears in `denied_permissions` _and_ in `exception_permissions` then it will _not_ be denied. The excluded permissions can be specified using the same syntax as `denied_permissions`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"exceptionPrincipals": { +"description": "The identities that are excluded from the deny rule, even if they are listed in the `denied_principals`. For example, you could add a Google group to the `denied_principals`, then exclude specific users who belong to that group. This field can contain the same values as the `denied_principals` field, excluding `principalSet://goog/public:all`, which represents all users on the internet.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleIamV2Policy": { +"description": "Data for an IAM policy.", +"id": "GoogleIamV2Policy", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters.", +"type": "object" +}, +"createTime": { +"description": "Output only. The time when the `Policy` was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deleteTime": { +"description": "Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "A user-specified description of the `Policy`. This value can be up to 63 characters.", +"type": "string" +}, +"etag": { +"description": "An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.", +"type": "string" +}, +"kind": { +"description": "Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.", +"type": "string" +}, +"rules": { +"description": "A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`.", +"items": { +"$ref": "GoogleIamV2PolicyRule" +}, +"type": "array" +}, +"uid": { +"description": "Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the `Policy` was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV2PolicyRule": { +"description": "A single rule in a `Policy`.", +"id": "GoogleIamV2PolicyRule", +"properties": { +"denyRule": { +"$ref": "GoogleIamV2DenyRule", +"description": "A rule for a deny policy." +}, +"description": { +"description": "A user-specified description of the rule. This value can be up to 256 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV3PolicyBinding": { +"description": "IAM policy binding resource.", +"id": "GoogleIamV3PolicyBinding", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations", +"type": "object" +}, +"condition": { +"$ref": "GoogleTypeExpr", +"description": "Optional. The condition to apply to the policy binding. When set, the `expression` field in the `Expr` must include from 1 to 10 subexpressions, joined by the \"||\"(Logical OR), \"&&\"(Logical AND) or \"!\"(Logical NOT) operators and cannot contain more than 250 characters. The condition is currently only supported when bound to policies of kind principal access boundary. When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are `principal.type` and `principal.subject`. An example expression is: \"principal.type == 'iam.googleapis.com/ServiceAccount'\" or \"principal.subject == 'bob@example.com'\". Allowed operations for `principal.subject`: - `principal.subject == ` - `principal.subject != ` - `principal.subject in []` - `principal.subject.startsWith()` - `principal.subject.endsWith()` Allowed operations for `principal.type`: - `principal.type == ` - `principal.type != ` - `principal.type in []` Supported principal types are Workspace, Workforce Pool, Workload Pool and Service Account. Allowed string must be one of: - iam.googleapis.com/WorkspaceIdentity - iam.googleapis.com/WorkforcePoolIdentity - iam.googleapis.com/WorkloadPoolIdentity - iam.googleapis.com/ServiceAccount" +}, +"createTime": { +"description": "Output only. The time when the policy binding was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The description of the policy binding. Must be less than or equal to 63 characters.", +"type": "string" +}, +"etag": { +"description": "Optional. The etag for the policy binding. If this is provided on update, it must match the server's etag.", +"type": "string" +}, +"name": { +"description": "Identifier. The name of the policy binding, in the format `{binding_parent/locations/{location}/policyBindings/{policy_binding_id}`. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target. Format: * `projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}` * `projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}` * `folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}` * `organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}`", +"type": "string" +}, +"policy": { +"description": "Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same organization.", +"type": "string" +}, +"policyKind": { +"description": "Immutable. The kind of the policy to attach in this binding. This field must be one of the following: - Left empty (will be automatically set to the policy kind) - The input policy kind", +"enum": [ +"POLICY_KIND_UNSPECIFIED", +"PRINCIPAL_ACCESS_BOUNDARY", +"ACCESS" +], +"enumDescriptions": [ +"Unspecified policy kind; Not a valid state", +"Principal access boundary policy kind", +"Access policy kind." +], +"type": "string" +}, +"policyUid": { +"description": "Output only. The globally unique ID of the policy to be bound.", +"readOnly": true, +"type": "string" +}, +"target": { +"$ref": "GoogleIamV3PolicyBindingTarget", +"description": "Required. Immutable. The full resource name of the resource to which the policy will be bound. Immutable once set." +}, +"uid": { +"description": "Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the policy binding was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV3PolicyBindingTarget": { +"description": "The full resource name of the resource to which the policy will be bound. Immutable once set.", +"id": "GoogleIamV3PolicyBindingTarget", +"properties": { +"principalSet": { +"description": "Immutable. The full resource name that's used for principal access boundary policy bindings. The principal set must be directly parented by the policy binding's parent or same as the parent if the target is a project, folder, or organization. Examples: * For bindings parented by an organization: * Organization: `//cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID` * Workforce Identity: `//iam.googleapis.com/locations/global/workforcePools/WORKFORCE_POOL_ID` * Workspace Identity: `//iam.googleapis.com/locations/global/workspace/WORKSPACE_ID` * For bindings parented by a folder: * Folder: `//cloudresourcemanager.googleapis.com/folders/FOLDER_ID` * For bindings parented by a project: * Project: * `//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER` * `//cloudresourcemanager.googleapis.com/projects/PROJECT_ID` * Workload Identity Pool: `//iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID`", +"type": "string" +}, +"resource": { +"description": "Immutable. The full resource name that's used for access policy bindings. Examples: * Organization: `//cloudresourcemanager.googleapis.com/organizations/ORGANIZATION_ID` * Folder: `//cloudresourcemanager.googleapis.com/folders/FOLDER_ID` * Project: * `//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER` * `//cloudresourcemanager.googleapis.com/projects/PROJECT_ID`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV3PrincipalAccessBoundaryPolicy": { +"description": "An IAM principal access boundary policy resource.", +"id": "GoogleIamV3PrincipalAccessBoundaryPolicy", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations", +"type": "object" +}, +"createTime": { +"description": "Output only. The time when the principal access boundary policy was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"details": { +"$ref": "GoogleIamV3PrincipalAccessBoundaryPolicyDetails", +"description": "Optional. The details for the principal access boundary policy." +}, +"displayName": { +"description": "Optional. The description of the principal access boundary policy. Must be less than or equal to 63 characters.", +"type": "string" +}, +"etag": { +"description": "Optional. The etag for the principal access boundary. If this is provided on update, it must match the server's etag.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the principal access boundary policy. The following format is supported: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{policy_id}`", +"type": "string" +}, +"uid": { +"description": "Output only. The globally unique ID of the principal access boundary policy.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the principal access boundary policy was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleIamV3PrincipalAccessBoundaryPolicyDetails": { +"description": "Principal access boundary policy details", +"id": "GoogleIamV3PrincipalAccessBoundaryPolicyDetails", +"properties": { +"enforcementVersion": { +"description": "Optional. The version number (for example, `1` or `latest`) that indicates which permissions are able to be blocked by the policy. If empty, the PAB policy version will be set to the most recent version number at the time of the policy's creation.", +"type": "string" +}, +"rules": { +"description": "Required. A list of principal access boundary policy rules. The number of rules in a policy is limited to 500.", +"items": { +"$ref": "GoogleIamV3PrincipalAccessBoundaryPolicyRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleIamV3PrincipalAccessBoundaryPolicyRule": { +"description": "Principal access boundary policy rule that defines the resource boundary.", +"id": "GoogleIamV3PrincipalAccessBoundaryPolicyRule", +"properties": { +"description": { +"description": "Optional. The description of the principal access boundary policy rule. Must be less than or equal to 256 characters.", +"type": "string" +}, +"effect": { +"description": "Required. The access relationship of principals to the resources in this rule.", +"enum": [ +"EFFECT_UNSPECIFIED", +"ALLOW" +], +"enumDescriptions": [ +"Effect unspecified.", +"Allows access to the resources in this rule." +], +"type": "string" +}, +"resources": { +"description": "Required. A list of Resource Manager resources. If a resource is listed in the rule, then the rule applies for that resource and its descendants. The number of resources in a policy is limited to 500 across all rules in the policy. The following resource types are supported: * Organizations, such as `//cloudresourcemanager.googleapis.com/organizations/123`. * Folders, such as `//cloudresourcemanager.googleapis.com/folders/123`. * Projects, such as `//cloudresourcemanager.googleapis.com/projects/123` or `//cloudresourcemanager.googleapis.com/projects/my-project-id`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleRpcStatus": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "GoogleRpcStatus", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleTypeExpr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "GoogleTypeExpr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Policy Troubleshooter API", +"version": "v3beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 49ee71a70d..aa564010e3 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -525,7 +525,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", +"description": "Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfigs/{configId}", "location": "path", "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", "required": true, @@ -1305,7 +1305,7 @@ } } }, -"revision": "20250508", +"revision": "20260114", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 46f98247b5..6b887e3a2c 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3142,7 +3142,7 @@ } } }, -"revision": "20251202", +"revision": "20260109", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -6142,7 +6142,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", +"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 61ffe47941..5486399ff2 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3436,7 +3436,7 @@ } } }, -"revision": "20251205", +"revision": "20251230", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Ack": { @@ -7189,7 +7189,7 @@ "type": "string" }, "transactionTag": { -"description": "A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.", +"description": "A tag used for statistics collection about this transaction. Both `request_tag` and `transaction_tag` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, `transaction_tag` must be set to the same value for all requests belonging to the same transaction, including BeginTransaction. If this request doesn't belong to any transaction, `transaction_tag` is ignored. Legal characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the length of a `transaction_tag` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters are removed from the string.", "type": "string" } },