diff --git a/docs/google-docs/index.md b/docs/google-docs/index.md
index 9dddec396d..79b32c4873 100644
--- a/docs/google-docs/index.md
+++ b/docs/google-docs/index.md
@@ -1,102 +1,100 @@
----
-title: google
-hide_title: false
-hide_table_of_contents: false
-keywords:
- - google
- - stackql
- - infrastructure-as-code
- - configuration-as-data
- - cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
-custom_edit_url: null
-image: /img/providers/google/stackql-google-provider-featured-image.png
-id: google-doc
-slug: /providers/google
----
+---
+title: google
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - google
+ - google cloud platform
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+id: google-doc
+slug: /providers/google
+
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
+Cloud services from Google.
-import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
-
-Cloud computing services offered by Google.
-
-:::info Provider Summary (v24.06.00236)
+:::info Provider Summary (v24.09.00251)
-total services: 163
-total methods: 8365
-
-
-total resources: 1706
-total selectable resources: 1438
+total services: 167
+total resources: 0
:::
-See also:
-[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
-* * *
-
-## Installation
-
-To pull the latest version of the `google` provider, run the following command:
-
-```bash
-REGISTRY PULL google;
-```
-> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
-
-## Authentication
-
-
-The following authentication methods are supported:
--
-- for running interactive queries from Cloud Shell or other machines where the user is authenticated using
-
-> for more information on creating service accounts and key files, see [Service accounts overview](https://cloud.google.com/iam/docs/service-account-overview).
-
-### Service Account Environment Variable (default)
-
-The following system environment variable is used by default:
-
-- - contents of the google
service account key json file. This variable is sourced at runtime (from the local machine using export GOOGLE_CREDENTIALS=cat creds/my-sa-key.json
for example or as a CI variable/secret).
-
-This variable is sourced at runtime (from the local machine using `export GOOGLE_CREDENTIALS=$(cat creds/my-sa-key.json)` for example or as a CI variable/secret).
-
-
-
-Specifying the service account key file location directly
-
-You can specify the path to the service account key file without using the default environment variable by using the flag of the stackql
program. For example:
-
-```bash
-AUTH='{ "google": { "type": "service_account", "credentialsfilepath": "creds/sa-key.json" }}'
-stackql shell --auth="${AUTH}"
-```
-
-or using PowerShell:
-
-```powershell
-$Auth = "{ 'google': { 'type': 'service_account', 'credentialsfilepath': 'creds/sa-key.json' }}"
-stackql.exe shell --auth=$Auth
-```
-
-
-
-### Interactive Authentication
-When you are using Google Cloud Shell or on a machine where you have authenticated using , you can then use the following authentication method:
-
-```bash
-AUTH='{ "google": { "type": "interactive" }}'
-stackql shell --auth="${AUTH}"
-```
-
-or using PowerShell:
-
-```powershell
-$Auth = "{ 'google': { 'type': 'interactive' }}"
-stackql.exe shell --auth=$Auth
+See also:
+[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
+* * *
+
+## Installation
+
+To pull the latest version of the `google` provider, run the following command:
+
+```bash
+REGISTRY PULL google;
+```
+> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).
+
+## Authentication
+
+
+The following authentication methods are supported:
+-
+- for running interactive queries from Cloud Shell or other machines where the user is authenticated using
+
+> for more information on creating service accounts and key files, see [Service accounts overview](https://cloud.google.com/iam/docs/service-account-overview).
+
+### Service Account Environment Variable (default)
+
+The following system environment variable is used by default:
+
+- - contents of the google
service account key json file. This variable is sourced at runtime (from the local machine using export GOOGLE_CREDENTIALS=cat creds/my-sa-key.json
for example or as a CI variable/secret).
+
+This variable is sourced at runtime (from the local machine using `export GOOGLE_CREDENTIALS=$(cat creds/my-sa-key.json)` for example or as a CI variable/secret).
+
+
+
+Specifying the service account key file location directly
+
+You can specify the path to the service account key file without using the default environment variable by using the flag of the stackql
program. For example:
+
+```bash
+AUTH='{ "google": { "type": "service_account", "credentialsfilepath": "creds/sa-key.json" }}'
+stackql shell --auth="${AUTH}"
+```
+
+or using PowerShell:
+
+```powershell
+$Auth = "{ 'google': { 'type': 'service_account', 'credentialsfilepath': 'creds/sa-key.json' }}"
+stackql.exe shell --auth=$Auth
+```
+
+
+
+### Interactive Authentication
+When you are using Google Cloud Shell or on a machine where you have authenticated using , you can then use the following authentication method:
+
+```bash
+AUTH='{ "google": { "type": "interactive" }}'
+stackql shell --auth="${AUTH}"
+```
+
+or using PowerShell:
+
+```powershell
+$Auth = "{ 'google': { 'type': 'interactive' }}"
+stackql.exe shell --auth=$Auth
```
## Services
@@ -107,12 +105,14 @@ stackql.exe shell --auth=$Auth
addressvalidation
advisorynotifications
aiplatform
+airquality
alloydb
analyticshub
apigateway
apigee
apigeeregistry
apikeys
+apim
appengine
apphub
artifactregistry
@@ -190,6 +190,8 @@ stackql.exe shell --auth=$Auth
healthcare
iam
iamcredentials
+iamv2
+iamv2beta
iap
identitytoolkit
ids
@@ -220,6 +222,7 @@ stackql.exe shell --auth=$Auth
policyanalyzer
policysimulator
policytroubleshooter
+pollen
privateca
prod_tt_sasportal
publicca
@@ -244,7 +247,6 @@ stackql.exe shell --auth=$Auth
servicenetworking
serviceusage
solar
-sourcerepo
spanner
speech
sqladmin
diff --git a/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md b/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md
index 5d385e7c31..38005e3300 100644
--- a/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md
+++ b/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md
@@ -1,3 +1,4 @@
+
---
title: access_approval_settings
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- access_approval_settings
- accessapproval
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an access_approval_setting
resource or lists access_approval_settings
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" |
+| | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" |
| | `string` | The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. |
| | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). |
| | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). |
@@ -40,7 +42,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Optional. A pubsub topic to which notifications relating to approval requests should be sent. |
| | `boolean` | This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. |
| | `integer` | This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. |
+| | `string` | Optional. A setting to indicate the maximum width of an Access Approval request. |
| | `boolean` | Optional. A setting to require approval request justifications to be customer visible. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -50,6 +54,60 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `DELETE` | | Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. |
| | `DELETE` | | Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. |
| | `DELETE` | | Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. |
-| | `EXEC` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
-| | `EXEC` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
-| | `EXEC` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
+| | `UPDATE` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
+| | `UPDATE` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
+| | `UPDATE` | | Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. |
+
+## `SELECT` examples
+
+Gets the settings associated with a project, folder, or organization.
+
+```sql
+SELECT
+name,
+activeKeyVersion,
+ancestorHasActiveKeyVersion,
+enrolledAncestor,
+enrolledServices,
+invalidKeyVersion,
+notificationEmails,
+notificationPubsubTopic,
+preferNoBroadApprovalRequests,
+preferredRequestExpirationDays,
+requestScopeMaxWidthPreference,
+requireCustomerVisibleJustification
+FROM google.accessapproval.access_approval_settings
+WHERE foldersId = '{{ foldersId }}';
+```
+
+## `UPDATE` example
+
+Updates a access_approval_setting only if the necessary resources are available.
+
+```sql
+UPDATE google.accessapproval.access_approval_settings
+SET
+name = '{{ name }}',
+notificationEmails = '{{ notificationEmails }}',
+enrolledServices = '{{ enrolledServices }}',
+enrolledAncestor = true|false,
+activeKeyVersion = '{{ activeKeyVersion }}',
+ancestorHasActiveKeyVersion = true|false,
+invalidKeyVersion = true|false,
+preferredRequestExpirationDays = '{{ preferredRequestExpirationDays }}',
+preferNoBroadApprovalRequests = true|false,
+notificationPubsubTopic = '{{ notificationPubsubTopic }}',
+requireCustomerVisibleJustification = true|false,
+requestScopeMaxWidthPreference = '{{ requestScopeMaxWidthPreference }}'
+WHERE
+foldersId = '{{ foldersId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified access_approval_setting resource.
+
+```sql
+DELETE FROM google.accessapproval.access_approval_settings
+WHERE foldersId = '{{ foldersId }}';
+```
diff --git a/docs/google-docs/providers/google/accessapproval/approval_requests/index.md b/docs/google-docs/providers/google/accessapproval/approval_requests/index.md
index 433b5766d6..4561e1b46d 100644
--- a/docs/google-docs/providers/google/accessapproval/approval_requests/index.md
+++ b/docs/google-docs/providers/google/accessapproval/approval_requests/index.md
@@ -1,3 +1,4 @@
+
---
title: approval_requests
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- approval_requests
- accessapproval
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an approval_request
resource or lists approval_requests
in a region
## Overview
@@ -30,16 +32,18 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The resource name of the request. Format is "{projects\|folders\|organizations}/{id}/approvalRequests/{approval_request}". |
+| | `string` | The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". |
| | `object` | A decision that has been made to approve access to a resource. |
| | `object` | A decision that has been made to dismiss an approval request. |
| | `string` | The time at which approval was requested. |
+| | `object` | This field contains the augmented information of the request. |
| | `string` | The requested access duration. |
| | `string` | The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time. |
| | `object` | Home office and physical location of the principal. |
| | `object` | |
| | `string` | The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. |
| | `object` | The properties associated with the resource of the request. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -49,9 +53,6 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| | `SELECT` | | Gets an approval request. Returns NOT_FOUND if the request does not exist. |
| | `SELECT` | | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
-| | `EXEC` | | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
-| | `EXEC` | | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
-| | `EXEC` | | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| | `EXEC` | | Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| | `EXEC` | | Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| | `EXEC` | | Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. |
@@ -61,3 +62,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `EXEC` | | Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| | `EXEC` | | Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| | `EXEC` | | Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. |
+
+## `SELECT` examples
+
+Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
+
+```sql
+SELECT
+name,
+approve,
+dismiss,
+requestTime,
+requestedAugmentedInfo,
+requestedDuration,
+requestedExpiration,
+requestedLocations,
+requestedReason,
+requestedResourceName,
+requestedResourceProperties
+FROM google.accessapproval.approval_requests
+WHERE foldersId = '{{ foldersId }}';
+```
diff --git a/docs/google-docs/providers/google/accessapproval/index.md b/docs/google-docs/providers/google/accessapproval/index.md
index a539a2db26..3913865018 100644
--- a/docs/google-docs/providers/google/accessapproval/index.md
+++ b/docs/google-docs/providers/google/accessapproval/index.md
@@ -9,41 +9,30 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-An API for controlling access to data by Google personnel.
-
+The accessapproval service documentation.
+
:::info Service Summary
total resources: 3
-total selectable resources: 3
-total methods: 30
:::
-## Overview
-
-Name | google.accessapproval |
-Type | Service |
-Title | Access Approval API |
-Description | An API for controlling access to data by Google personnel. |
-Id | accessapproval:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/accessapproval/service_account/index.md b/docs/google-docs/providers/google/accessapproval/service_account/index.md
index 01b967a6a6..79282459ae 100644
--- a/docs/google-docs/providers/google/accessapproval/service_account/index.md
+++ b/docs/google-docs/providers/google/accessapproval/service_account/index.md
@@ -1,3 +1,4 @@
+
---
title: service_account
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- service_account
- accessapproval
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an service_account
resource or lists service_account
in a region
## Overview
@@ -30,11 +32,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The resource name of the Access Approval service account. Format is one of: * "projects/{project}/serviceAccount" * "folders/{folder}/serviceAccount" * "organizations/{organization}/serviceAccount" |
+| | `string` | The resource name of the Access Approval service account. Format is one of: * "projects/{project}/serviceAccount" * "folders/{folder}/serviceAccount" * "organizations/{organization}/serviceAccount" |
| | `string` | Email address of the service account. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `SELECT` | |
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests. |
+| | `SELECT` | | Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests. |
+| | `SELECT` | | Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests. |
+
+## `SELECT` examples
+
+Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.
+
+```sql
+SELECT
+name,
+accountEmail
+FROM google.accessapproval.service_account
+WHERE foldersId = '{{ foldersId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md
index 5b277de119..cc54a603fd 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md
@@ -1,3 +1,4 @@
+
---
title: access_levels
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- access_levels
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an access_level
resource or lists access_levels
in a region
## Overview
@@ -30,11 +32,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. After you create an `AccessLevel`, you cannot change its `name`. |
+| | `string` | Identifier. Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. After you create an `AccessLevel`, you cannot change its `name`. |
| | `string` | Description of the `AccessLevel` and its use. Does not affect behavior. |
| | `object` | `BasicLevel` is an `AccessLevel` using a set of recommended features. |
| | `object` | `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec |
| | `string` | Human readable title. Must be unique within the Policy. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,5 +46,100 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. |
| | `DELETE` | | Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage. |
| | `UPDATE` | | Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. |
-| | `EXEC` | | Lists all access levels for an access policy. |
| | `EXEC` | | Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error. |
+
+## `SELECT` examples
+
+Lists all access levels for an access policy.
+
+```sql
+SELECT
+name,
+description,
+basic,
+custom,
+title
+FROM google.accesscontextmanager.access_levels
+WHERE accessPoliciesId = '{{ accessPoliciesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new access_levels
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.accesscontextmanager.access_levels (
+accessPoliciesId,
+name,
+title,
+description,
+basic,
+custom
+)
+SELECT
+'{{ accessPoliciesId }}',
+'{{ name }}',
+'{{ title }}',
+'{{ description }}',
+'{{ basic }}',
+'{{ custom }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: title
+ value: '{{ title }}'
+ - name: description
+ value: '{{ description }}'
+ - name: basic
+ value: '{{ basic }}'
+ - name: custom
+ value: '{{ custom }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a access_level only if the necessary resources are available.
+
+```sql
+UPDATE google.accesscontextmanager.access_levels
+SET
+name = '{{ name }}',
+title = '{{ title }}',
+description = '{{ description }}',
+basic = '{{ basic }}',
+custom = '{{ custom }}'
+WHERE
+accessLevelsId = '{{ accessLevelsId }}'
+AND accessPoliciesId = '{{ accessPoliciesId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified access_level resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.access_levels
+WHERE accessLevelsId = '{{ accessLevelsId }}'
+AND accessPoliciesId = '{{ accessPoliciesId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_levels_iam_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_levels_iam_policies/index.md
index ce252adcbd..42500ce129 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/access_levels_iam_policies/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/access_levels_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: access_levels_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- access_levels_iam_policies
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an access_levels_iam_policy
resource or lists access_levels_iam_policies
in a region
## Overview
@@ -28,8 +30,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. |
diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md
index d0a9fc3a46..b72be4c5a7 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: access_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- access_policies
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an access_policy
resource or lists access_policies
in a region
## Overview
@@ -30,17 +32,111 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` |
-| | `string` | Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. |
-| | `string` | Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` |
-| | `array` | The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the following behavior: - ServicePerimeter can only restrict projects within `folders/123`. - ServicePerimeter within policy A can only reference access levels defined within policy A. - Only one policy can include a given scope; thus, attempting to create a second policy which includes `folders/123` will result in an error. If no scopes are provided, then any resource within the organization can be restricted. Scopes cannot be modified after a policy is created. Policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` |
+| | `string` | Output only. Identifier. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` |
+| | `string` | Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. |
+| | `string` | Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` |
+| | `array` | The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where its resources can be referenced. For example, policy A with `scopes=["folders/123"]` has the following behavior: - ServicePerimeter can only restrict projects within `folders/123`. - ServicePerimeter within policy A can only reference access levels defined within policy A. - Only one policy can include a given scope; thus, attempting to create a second policy which includes `folders/123` will result in an error. If no scopes are provided, then any resource within the organization can be restricted. Scopes cannot be modified after a policy is created. Policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` |
| | `string` | Required. Human readable title. Does not affect behavior. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Returns an access policy based on the name. |
-| | `SELECT` | | Lists all access policies in an organization. |
-| | `INSERT` | | Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto. |
+| | `SELECT` | | Lists all access policies in an organization. |
+| | `INSERT` | | Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto. |
| | `DELETE` | | Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage. |
| | `UPDATE` | | Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage. |
-| | `EXEC` | | Lists all access policies in an organization. |
+
+## `SELECT` examples
+
+Lists all access policies in an organization.
+
+```sql
+SELECT
+name,
+etag,
+parent,
+scopes,
+title
+FROM google.accesscontextmanager.access_policies
+WHERE = '{{ }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new access_policies
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.accesscontextmanager.access_policies (
+,
+name,
+parent,
+title,
+scopes,
+etag
+)
+SELECT
+'{{ }}',
+'{{ name }}',
+'{{ parent }}',
+'{{ title }}',
+'{{ scopes }}',
+'{{ etag }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: parent
+ value: '{{ parent }}'
+ - name: title
+ value: '{{ title }}'
+ - name: scopes
+ value: '{{ scopes }}'
+ - name: etag
+ value: '{{ etag }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a access_policy only if the necessary resources are available.
+
+```sql
+UPDATE google.accesscontextmanager.access_policies
+SET
+name = '{{ name }}',
+parent = '{{ parent }}',
+title = '{{ title }}',
+scopes = '{{ scopes }}',
+etag = '{{ etag }}'
+WHERE
+accessPoliciesId = '{{ accessPoliciesId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified access_policy resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.access_policies
+WHERE accessPoliciesId = '{{ accessPoliciesId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md
index 9c24eeefb7..1f494d004f 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: access_policies_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- access_policies_iam_policies
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an access_policies_iam_policy
resource or lists access_policies_iam_policies
in a region
## Overview
@@ -30,13 +32,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the IAM policy for the specified Access Context Manager access policy. |
-| | `EXEC` | | Gets the IAM policy for the specified Access Context Manager access policy. |
| | `EXEC` | | Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy. |
| | `EXEC` | | Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. |
+
+## `SELECT` examples
+
+Gets the IAM policy for the specified Access Context Manager access policy.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.accesscontextmanager.access_policies_iam_policies
+WHERE accessPoliciesId = '{{ accessPoliciesId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md b/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md
index 6adbef0bf3..42e01057b7 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md
@@ -1,3 +1,4 @@
+
---
title: authorized_orgs_descs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- authorized_orgs_descs
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an authorized_orgs_desc
resource or lists authorized_orgs_descs
in a region
## Overview
@@ -30,11 +32,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`. |
+| | `string` | Identifier. Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`. |
| | `string` | The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`. |
| | `string` | The direction of the authorization relationship between this organization and the organizations listed in the `orgs` field. The valid values for this field include the following: `AUTHORIZATION_DIRECTION_FROM`: Allows this organization to evaluate traffic in the organizations listed in the `orgs` field. `AUTHORIZATION_DIRECTION_TO`: Allows the organizations listed in the `orgs` field to evaluate the traffic in this organization. For the authorization relationship to take effect, all of the organizations must authorize and specify the appropriate relationship direction. For example, if organization A authorized organization B and C to evaluate its traffic, by specifying `AUTHORIZATION_DIRECTION_TO` as the authorization direction, organizations B and C must specify `AUTHORIZATION_DIRECTION_FROM` as the authorization direction in their `AuthorizedOrgsDesc` resource. |
| | `string` | A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`. |
| | `array` | The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456` |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,4 +46,99 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation. |
| | `DELETE` | | Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage. |
| | `UPDATE` | | Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated. |
-| | `EXEC` | | Lists all authorized orgs descs for an access policy. |
+
+## `SELECT` examples
+
+Lists all authorized orgs descs for an access policy.
+
+```sql
+SELECT
+name,
+assetType,
+authorizationDirection,
+authorizationType,
+orgs
+FROM google.accesscontextmanager.authorized_orgs_descs
+WHERE accessPoliciesId = '{{ accessPoliciesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new authorized_orgs_descs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.accesscontextmanager.authorized_orgs_descs (
+accessPoliciesId,
+name,
+authorizationType,
+assetType,
+authorizationDirection,
+orgs
+)
+SELECT
+'{{ accessPoliciesId }}',
+'{{ name }}',
+'{{ authorizationType }}',
+'{{ assetType }}',
+'{{ authorizationDirection }}',
+'{{ orgs }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: authorizationType
+ value: '{{ authorizationType }}'
+ - name: assetType
+ value: '{{ assetType }}'
+ - name: authorizationDirection
+ value: '{{ authorizationDirection }}'
+ - name: orgs
+ value: '{{ orgs }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a authorized_orgs_desc only if the necessary resources are available.
+
+```sql
+UPDATE google.accesscontextmanager.authorized_orgs_descs
+SET
+name = '{{ name }}',
+authorizationType = '{{ authorizationType }}',
+assetType = '{{ assetType }}',
+authorizationDirection = '{{ authorizationDirection }}',
+orgs = '{{ orgs }}'
+WHERE
+accessPoliciesId = '{{ accessPoliciesId }}'
+AND authorizedOrgsDescsId = '{{ authorizedOrgsDescsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified authorized_orgs_desc resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.authorized_orgs_descs
+WHERE accessPoliciesId = '{{ accessPoliciesId }}'
+AND authorizedOrgsDescsId = '{{ authorizedOrgsDescsId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md
index d7498f5b59..0c99d3b38d 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md
@@ -1,3 +1,4 @@
+
---
title: gcp_user_access_bindings
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- gcp_user_access_bindings
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an gcp_user_access_binding
resource or lists gcp_user_access_bindings
in a region
## Overview
@@ -34,7 +36,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" |
| | `array` | Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" |
| | `string` | Required. Immutable. Google Group id whose members are subject to this binding's restrictions. See "id" in the [G Suite Directory API's Groups resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" |
+| | `object` | Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. |
| | `array` | Optional. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. |
+| | `array` | Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,4 +48,111 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time. |
| | `DELETE` | | Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time. |
| | `UPDATE` | | Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time. |
-| | `EXEC` | | Lists all GcpUserAccessBindings for a Google Cloud organization. |
+
+## `SELECT` examples
+
+Lists all GcpUserAccessBindings for a Google Cloud organization.
+
+```sql
+SELECT
+name,
+accessLevels,
+dryRunAccessLevels,
+groupKey,
+reauthSettings,
+restrictedClientApplications,
+scopedAccessSettings
+FROM google.accesscontextmanager.gcp_user_access_bindings
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new gcp_user_access_bindings
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.accesscontextmanager.gcp_user_access_bindings (
+organizationsId,
+name,
+groupKey,
+accessLevels,
+dryRunAccessLevels,
+reauthSettings,
+restrictedClientApplications,
+scopedAccessSettings
+)
+SELECT
+'{{ organizationsId }}',
+'{{ name }}',
+'{{ groupKey }}',
+'{{ accessLevels }}',
+'{{ dryRunAccessLevels }}',
+'{{ reauthSettings }}',
+'{{ restrictedClientApplications }}',
+'{{ scopedAccessSettings }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: groupKey
+ value: '{{ groupKey }}'
+ - name: accessLevels
+ value: '{{ accessLevels }}'
+ - name: dryRunAccessLevels
+ value: '{{ dryRunAccessLevels }}'
+ - name: reauthSettings
+ value: '{{ reauthSettings }}'
+ - name: restrictedClientApplications
+ value: '{{ restrictedClientApplications }}'
+ - name: scopedAccessSettings
+ value: '{{ scopedAccessSettings }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a gcp_user_access_binding only if the necessary resources are available.
+
+```sql
+UPDATE google.accesscontextmanager.gcp_user_access_bindings
+SET
+name = '{{ name }}',
+groupKey = '{{ groupKey }}',
+accessLevels = '{{ accessLevels }}',
+dryRunAccessLevels = '{{ dryRunAccessLevels }}',
+reauthSettings = '{{ reauthSettings }}',
+restrictedClientApplications = '{{ restrictedClientApplications }}',
+scopedAccessSettings = '{{ scopedAccessSettings }}'
+WHERE
+gcpUserAccessBindingsId = '{{ gcpUserAccessBindingsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified gcp_user_access_binding resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.gcp_user_access_bindings
+WHERE gcpUserAccessBindingsId = '{{ gcpUserAccessBindingsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/index.md b/docs/google-docs/providers/google/accesscontextmanager/index.md
index 07b4dd8863..32f847df31 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/index.md
@@ -9,34 +9,23 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters.
-
+The accesscontextmanager service documentation.
+
:::info Service Summary
total resources: 10
-total selectable resources: 8
-total methods: 47
:::
-## Overview
-
-Name | google.accesscontextmanager |
-Type | Service |
-Title | Access Context Manager API |
-Description | An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters. |
-Id | accesscontextmanager:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md
index 993b4b2c6f..968e8e315f 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md
@@ -1,3 +1,4 @@
+
---
title: operations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- operations
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an operation
resource or lists operations
in a region
## Overview
@@ -30,16 +32,40 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `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}`. |
+| | `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}`. |
| | `boolean` | 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. |
| | `object` | 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). |
| | `object` | 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. |
| | `object` | 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`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | 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. |
-| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
+| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `DELETE` | | 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`. |
-| | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `EXEC` | | 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`. |
+
+## `SELECT` examples
+
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+```sql
+SELECT
+name,
+done,
+error,
+metadata,
+response
+FROM google.accesscontextmanager.operations
+WHERE = '{{ }}';
+```
+
+## `DELETE` example
+
+Deletes the specified operation resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.operations
+WHERE operationsId = '{{ operationsId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md
index 97e55f9271..4685d49f0e 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md
@@ -1,3 +1,4 @@
+
---
title: service_perimeters
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- service_perimeters
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an service_perimeter
resource or lists service_perimeters
in a region
## Overview
@@ -30,13 +32,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`. |
+| | `string` | Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`. |
| | `string` | Description of the `ServicePerimeter` and its use. Does not affect behavior. |
| | `string` | Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. |
| | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. |
| | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. |
| | `string` | Human readable title. Must be unique within the Policy. |
| | `boolean` | Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -45,6 +48,113 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. |
| | `DELETE` | | Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage. |
| | `UPDATE` | | Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. |
-| | `EXEC` | | Lists all service perimeters for an access policy. |
| | `EXEC` | | Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation. |
| | `EXEC` | | Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse. |
+
+## `SELECT` examples
+
+Lists all service perimeters for an access policy.
+
+```sql
+SELECT
+name,
+description,
+perimeterType,
+spec,
+status,
+title,
+useExplicitDryRunSpec
+FROM google.accesscontextmanager.service_perimeters
+WHERE accessPoliciesId = '{{ accessPoliciesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new service_perimeters
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.accesscontextmanager.service_perimeters (
+accessPoliciesId,
+name,
+title,
+description,
+perimeterType,
+status,
+spec,
+useExplicitDryRunSpec
+)
+SELECT
+'{{ accessPoliciesId }}',
+'{{ name }}',
+'{{ title }}',
+'{{ description }}',
+'{{ perimeterType }}',
+'{{ status }}',
+'{{ spec }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: title
+ value: '{{ title }}'
+ - name: description
+ value: '{{ description }}'
+ - name: perimeterType
+ value: '{{ perimeterType }}'
+ - name: status
+ value: '{{ status }}'
+ - name: spec
+ value: '{{ spec }}'
+ - name: useExplicitDryRunSpec
+ value: '{{ useExplicitDryRunSpec }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a service_perimeter only if the necessary resources are available.
+
+```sql
+UPDATE google.accesscontextmanager.service_perimeters
+SET
+name = '{{ name }}',
+title = '{{ title }}',
+description = '{{ description }}',
+perimeterType = '{{ perimeterType }}',
+status = '{{ status }}',
+spec = '{{ spec }}',
+useExplicitDryRunSpec = true|false
+WHERE
+accessPoliciesId = '{{ accessPoliciesId }}'
+AND servicePerimetersId = '{{ servicePerimetersId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified service_perimeter resource.
+
+```sql
+DELETE FROM google.accesscontextmanager.service_perimeters
+WHERE accessPoliciesId = '{{ accessPoliciesId }}'
+AND servicePerimetersId = '{{ servicePerimetersId }}';
+```
diff --git a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters_iam_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters_iam_policies/index.md
index 25043a7153..c443247295 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters_iam_policies/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: service_perimeters_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- service_perimeters_iam_policies
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an service_perimeters_iam_policy
resource or lists service_perimeters_iam_policies
in a region
## Overview
@@ -28,8 +30,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. |
diff --git a/docs/google-docs/providers/google/accesscontextmanager/services/index.md b/docs/google-docs/providers/google/accesscontextmanager/services/index.md
index c206c9cef6..1d419a6379 100644
--- a/docs/google-docs/providers/google/accesscontextmanager/services/index.md
+++ b/docs/google-docs/providers/google/accesscontextmanager/services/index.md
@@ -1,3 +1,4 @@
+
---
title: services
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- services
- accesscontextmanager
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an service
resource or lists services
in a region
## Overview
@@ -33,12 +35,30 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The service name or address of the supported service, such as `service.googleapis.com`. |
| | `boolean` | True if the service is available on the restricted VIP. Services on the restricted VIP typically either support VPC Service Controls or are core infrastructure services required for the functioning of Google Cloud. |
| | `boolean` | True if the service is supported with some limitations. Check [documentation](https://cloud.google.com/vpc-service-controls/docs/supported-products) for details. |
+| | `string` | The support stage of the service. |
| | `string` | The support stage of the service. |
| | `array` | The list of the supported methods. This field exists only in response to GetSupportedService |
| | `string` | The name of the supported product, such as 'Cloud Product API'. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Returns a VPC-SC supported service based on the service name. |
-| | `SELECT` | | Lists all VPC-SC supported services. |
-| | `EXEC` | | Lists all VPC-SC supported services. |
+| | `SELECT` | | Lists all VPC-SC supported services. |
+
+## `SELECT` examples
+
+Lists all VPC-SC supported services.
+
+```sql
+SELECT
+name,
+availableOnRestrictedVip,
+knownLimitations,
+serviceSupportStage,
+supportStage,
+supportedMethods,
+title
+FROM google.accesscontextmanager.services
+WHERE = '{{ }}';
+```
diff --git a/docs/google-docs/providers/google/addressvalidation/addressvalidation/index.md b/docs/google-docs/providers/google/addressvalidation/addressvalidation/index.md
index e0048d4939..d091a9c966 100644
--- a/docs/google-docs/providers/google/addressvalidation/addressvalidation/index.md
+++ b/docs/google-docs/providers/google/addressvalidation/addressvalidation/index.md
@@ -1,3 +1,4 @@
+
---
title: addressvalidation
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- addressvalidation
- addressvalidation
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an addressvalidation
resource or lists addressvalidation
in a region
## Overview
@@ -28,9 +30,11 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
-| | `EXEC` | | Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of `ValidateAddress` requests needed to validate an address fully. |
-| | `EXEC` | | Validates an address. |
+| | `EXEC` | | Feedback about the outcome of the sequence of validation attempts. This should be the last call made after a sequence of validation calls for the same address, and should be called once the transaction is concluded. This should only be sent once for the sequence of `ValidateAddress` requests needed to validate an address fully. |
+| | `EXEC` | | Validates an address. |
diff --git a/docs/google-docs/providers/google/addressvalidation/index.md b/docs/google-docs/providers/google/addressvalidation/index.md
index 2afcd632c9..f847c9139d 100644
--- a/docs/google-docs/providers/google/addressvalidation/index.md
+++ b/docs/google-docs/providers/google/addressvalidation/index.md
@@ -9,39 +9,29 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address.
-
+The addressvalidation service documentation.
+
:::info Service Summary
total resources: 1
-total selectable resources: 0
-total methods: 2
:::
-## Overview
-
-Name | google.addressvalidation |
-Type | Service |
-Title | Address Validation API |
-Description | The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address. |
-Id | addressvalidation:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/advisorynotifications/index.md b/docs/google-docs/providers/google/advisorynotifications/index.md
index cbd0cc514f..b795f32969 100644
--- a/docs/google-docs/providers/google/advisorynotifications/index.md
+++ b/docs/google-docs/providers/google/advisorynotifications/index.md
@@ -9,40 +9,29 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-An API for accessing Advisory Notifications in Google Cloud
-
+The advisorynotifications service documentation.
+
:::info Service Summary
total resources: 2
-total selectable resources: 2
-total methods: 5
:::
-## Overview
-
-Name | google.advisorynotifications |
-Type | Service |
-Title | Advisory Notifications API |
-Description | An API for accessing Advisory Notifications in Google Cloud |
-Id | advisorynotifications:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md
index 0379f20c8c..7b2d3469d3 100644
--- a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md
+++ b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md
@@ -1,3 +1,4 @@
+
---
title: notifications
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- notifications
- advisorynotifications
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an notification
resource or lists notifications
in a region
## Overview
@@ -30,14 +32,30 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}. |
+| | `string` | The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{project}/locations/{location}/notifications/{notification}. |
| | `string` | Output only. Time the notification was created. |
| | `array` | A list of messages in the notification. |
| | `string` | Type of notification |
| | `object` | A subject line of a notification. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a notification. |
| | `SELECT` | | Lists notifications under a given parent. |
-| | `EXEC` | | Lists notifications under a given parent. |
+
+## `SELECT` examples
+
+Lists notifications under a given parent.
+
+```sql
+SELECT
+name,
+createTime,
+messages,
+notificationType,
+subject
+FROM google.advisorynotifications.notifications
+WHERE locationsId = '{{ locationsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/advisorynotifications/settings/index.md b/docs/google-docs/providers/google/advisorynotifications/settings/index.md
index e611688982..6a1520c230 100644
--- a/docs/google-docs/providers/google/advisorynotifications/settings/index.md
+++ b/docs/google-docs/providers/google/advisorynotifications/settings/index.md
@@ -1,3 +1,4 @@
+
---
title: settings
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- settings
- advisorynotifications
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an setting
resource or lists settings
in a region
## Overview
@@ -30,11 +32,41 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. |
+| | `string` | Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. |
| | `string` | Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle. |
| | `object` | Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Get notification settings. |
-| | `EXEC` | | Update notification settings. |
+| | `UPDATE` | | Update notification settings. |
+
+## `SELECT` examples
+
+Get notification settings.
+
+```sql
+SELECT
+name,
+etag,
+notificationSettings
+FROM google.advisorynotifications.settings
+WHERE locationsId = '{{ locationsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `UPDATE` example
+
+Updates a setting only if the necessary resources are available.
+
+```sql
+UPDATE google.advisorynotifications.settings
+SET
+etag = '{{ etag }}',
+name = '{{ name }}',
+notificationSettings = '{{ notificationSettings }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md b/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md
index 0f30d958f7..6c7db31bc7 100644
--- a/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md
@@ -1,3 +1,4 @@
+
---
title: annotation_specs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- annotation_specs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an annotation_spec
resource or lists annotation_specs
in a region
## Overview
@@ -35,7 +37,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. The user-defined name of the AnnotationSpec. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `string` | Output only. Timestamp when AnnotationSpec was last updated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets an AnnotationSpec. |
+
+## `SELECT` examples
+
+Gets an AnnotationSpec.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+etag,
+updateTime
+FROM google.aiplatform.annotation_specs
+WHERE annotationSpecsId = '{{ annotationSpecsId }}'
+AND datasetsId = '{{ datasetsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/annotations/index.md b/docs/google-docs/providers/google/aiplatform/annotations/index.md
index 4a21012e3d..669c8dd112 100644
--- a/docs/google-docs/providers/google/aiplatform/annotations/index.md
+++ b/docs/google-docs/providers/google/aiplatform/annotations/index.md
@@ -1,3 +1,4 @@
+
---
title: annotations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- annotations
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an annotation
resource or lists annotations
in a region
## Overview
@@ -38,8 +40,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `any` | Required. The schema of the payload can be found in payload_schema. |
| | `string` | Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an [OpenAPI 3.0.2 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata. |
| | `string` | Output only. Timestamp when this Annotation was last updated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. |
+
+## `SELECT` examples
+
+Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
+
+```sql
+SELECT
+name,
+annotationSource,
+createTime,
+etag,
+labels,
+payload,
+payloadSchemaUri,
+updateTime
+FROM google.aiplatform.annotations
+WHERE dataItemsId = '{{ dataItemsId }}'
+AND datasetsId = '{{ datasetsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/artifacts/index.md b/docs/google-docs/providers/google/aiplatform/artifacts/index.md
index 628662a668..f5e2c2461b 100644
--- a/docs/google-docs/providers/google/aiplatform/artifacts/index.md
+++ b/docs/google-docs/providers/google/aiplatform/artifacts/index.md
@@ -1,3 +1,4 @@
+
---
title: artifacts
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- artifacts
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an artifact
resource or lists artifacts
in a region
## Overview
@@ -42,14 +44,162 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions. |
| | `string` | Output only. Timestamp when this Artifact was last updated. |
| | `string` | The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Retrieves a specific Artifact. |
| | `SELECT` | | Lists Artifacts in the MetadataStore. |
+| | `SELECT` | | Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. |
| | `INSERT` | | Creates an Artifact associated with a MetadataStore. |
| | `DELETE` | | Deletes an Artifact. |
| | `UPDATE` | | Updates a stored Artifact. |
-| | `EXEC` | | Lists Artifacts in the MetadataStore. |
| | `EXEC` | | Purges Artifacts. |
-| | `EXEC` | | Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. |
+
+## `SELECT` examples
+
+Lists Artifacts in the MetadataStore.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+etag,
+labels,
+metadata,
+schemaTitle,
+schemaVersion,
+state,
+updateTime,
+uri
+FROM google.aiplatform.artifacts
+WHERE locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new artifacts
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.artifacts (
+locationsId,
+metadataStoresId,
+projectsId,
+etag,
+schemaTitle,
+name,
+metadata,
+updateTime,
+labels,
+schemaVersion,
+state,
+displayName,
+description,
+uri,
+createTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ etag }}',
+'{{ schemaTitle }}',
+'{{ name }}',
+'{{ metadata }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ schemaVersion }}',
+'{{ state }}',
+'{{ displayName }}',
+'{{ description }}',
+'{{ uri }}',
+'{{ createTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: etag
+ value: '{{ etag }}'
+ - name: schemaTitle
+ value: '{{ schemaTitle }}'
+ - name: name
+ value: '{{ name }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: schemaVersion
+ value: '{{ schemaVersion }}'
+ - name: state
+ value: '{{ state }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: description
+ value: '{{ description }}'
+ - name: uri
+ value: '{{ uri }}'
+ - name: createTime
+ value: '{{ createTime }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a artifact only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.artifacts
+SET
+etag = '{{ etag }}',
+schemaTitle = '{{ schemaTitle }}',
+name = '{{ name }}',
+metadata = '{{ metadata }}',
+updateTime = '{{ updateTime }}',
+labels = '{{ labels }}',
+schemaVersion = '{{ schemaVersion }}',
+state = '{{ state }}',
+displayName = '{{ displayName }}',
+description = '{{ description }}',
+uri = '{{ uri }}',
+createTime = '{{ createTime }}'
+WHERE
+artifactsId = '{{ artifactsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified artifact resource.
+
+```sql
+DELETE FROM google.aiplatform.artifacts
+WHERE artifactsId = '{{ artifactsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md b/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md
index 45f70a7e84..076aca4da4 100644
--- a/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: batch_prediction_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- batch_prediction_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an batch_prediction_job
resource or lists batch_prediction_jobs
in a region
## Overview
@@ -45,18 +47,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. |
| | `object` | The labels with user-defined metadata to organize BatchPredictionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `object` | Manual batch tuning parameters. |
-| | `string` | The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set. The model resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` |
+| | `string` | The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set. The model resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` |
| | `any` | The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. |
| | `string` | Output only. The version ID of the Model that produces the predictions via this job. |
| | `object` | Configures the output of BatchPredictionJob. See Model.supported_output_storage_formats for supported output formats, and how predictions are expressed via any of them. |
| | `object` | Further describes this job's output. Supplements output_config. |
| | `array` | Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details. |
| | `object` | Statistics information about resource consumption. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. |
| | `string` | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. |
| | `string` | Output only. The detailed state of the job. |
| | `object` | Contains model information necessary to perform batch prediction without requiring a full model import. |
| | `string` | Output only. Time when the BatchPredictionJob was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -64,5 +69,207 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists BatchPredictionJobs in a Location. |
| | `INSERT` | | Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. |
| | `DELETE` | | Deletes a BatchPredictionJob. Can only be called on jobs that already finished. |
-| | `EXEC` | | Lists BatchPredictionJobs in a Location. |
| | `EXEC` | | Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. |
+
+## `SELECT` examples
+
+Lists BatchPredictionJobs in a Location.
+
+```sql
+SELECT
+name,
+completionStats,
+createTime,
+dedicatedResources,
+disableContainerLogging,
+displayName,
+encryptionSpec,
+endTime,
+error,
+explanationSpec,
+generateExplanation,
+inputConfig,
+instanceConfig,
+labels,
+manualBatchTuningParameters,
+model,
+modelParameters,
+modelVersionId,
+outputConfig,
+outputInfo,
+partialFailures,
+resourcesConsumed,
+satisfiesPzi,
+satisfiesPzs,
+serviceAccount,
+startTime,
+state,
+unmanagedContainerModel,
+updateTime
+FROM google.aiplatform.batch_prediction_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new batch_prediction_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.batch_prediction_jobs (
+locationsId,
+projectsId,
+createTime,
+disableContainerLogging,
+completionStats,
+displayName,
+satisfiesPzs,
+labels,
+error,
+generateExplanation,
+explanationSpec,
+serviceAccount,
+manualBatchTuningParameters,
+dedicatedResources,
+resourcesConsumed,
+name,
+model,
+endTime,
+unmanagedContainerModel,
+updateTime,
+instanceConfig,
+outputConfig,
+outputInfo,
+inputConfig,
+modelVersionId,
+state,
+satisfiesPzi,
+partialFailures,
+modelParameters,
+encryptionSpec,
+startTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ createTime }}',
+true|false,
+'{{ completionStats }}',
+'{{ displayName }}',
+true|false,
+'{{ labels }}',
+'{{ error }}',
+true|false,
+'{{ explanationSpec }}',
+'{{ serviceAccount }}',
+'{{ manualBatchTuningParameters }}',
+'{{ dedicatedResources }}',
+'{{ resourcesConsumed }}',
+'{{ name }}',
+'{{ model }}',
+'{{ endTime }}',
+'{{ unmanagedContainerModel }}',
+'{{ updateTime }}',
+'{{ instanceConfig }}',
+'{{ outputConfig }}',
+'{{ outputInfo }}',
+'{{ inputConfig }}',
+'{{ modelVersionId }}',
+'{{ state }}',
+true|false,
+'{{ partialFailures }}',
+'{{ modelParameters }}',
+'{{ encryptionSpec }}',
+'{{ startTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: disableContainerLogging
+ value: '{{ disableContainerLogging }}'
+ - name: completionStats
+ value: '{{ completionStats }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: error
+ value: '{{ error }}'
+ - name: generateExplanation
+ value: '{{ generateExplanation }}'
+ - name: explanationSpec
+ value: '{{ explanationSpec }}'
+ - name: serviceAccount
+ value: '{{ serviceAccount }}'
+ - name: manualBatchTuningParameters
+ value: '{{ manualBatchTuningParameters }}'
+ - name: dedicatedResources
+ value: '{{ dedicatedResources }}'
+ - name: resourcesConsumed
+ value: '{{ resourcesConsumed }}'
+ - name: name
+ value: '{{ name }}'
+ - name: model
+ value: '{{ model }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: unmanagedContainerModel
+ value: '{{ unmanagedContainerModel }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: instanceConfig
+ value: '{{ instanceConfig }}'
+ - name: outputConfig
+ value: '{{ outputConfig }}'
+ - name: outputInfo
+ value: '{{ outputInfo }}'
+ - name: inputConfig
+ value: '{{ inputConfig }}'
+ - name: modelVersionId
+ value: '{{ modelVersionId }}'
+ - name: state
+ value: '{{ state }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: partialFailures
+ value: '{{ partialFailures }}'
+ - name: modelParameters
+ value: '{{ modelParameters }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: startTime
+ value: '{{ startTime }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified batch_prediction_job resource.
+
+```sql
+DELETE FROM google.aiplatform.batch_prediction_jobs
+WHERE batchPredictionJobsId = '{{ batchPredictionJobsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/contexts/index.md b/docs/google-docs/providers/google/aiplatform/contexts/index.md
index 14db167613..8bb220e6d8 100644
--- a/docs/google-docs/providers/google/aiplatform/contexts/index.md
+++ b/docs/google-docs/providers/google/aiplatform/contexts/index.md
@@ -1,3 +1,4 @@
+
---
title: contexts
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- contexts
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an context
resource or lists contexts
in a region
## Overview
@@ -41,14 +43,156 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
| | `string` | The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
| | `string` | Output only. Timestamp when this Context was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Retrieves a specific Context. |
| | `SELECT` | | Lists Contexts on the MetadataStore. |
+| | `SELECT` | | Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. |
| | `INSERT` | | Creates a Context associated with a MetadataStore. |
| | `DELETE` | | Deletes a stored Context. |
| | `UPDATE` | | Updates a stored Context. |
-| | `EXEC` | | Lists Contexts on the MetadataStore. |
| | `EXEC` | | Purges Contexts. |
-| | `EXEC` | | Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. |
+
+## `SELECT` examples
+
+Lists Contexts on the MetadataStore.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+etag,
+labels,
+metadata,
+parentContexts,
+schemaTitle,
+schemaVersion,
+updateTime
+FROM google.aiplatform.contexts
+WHERE locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new contexts
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.contexts (
+locationsId,
+metadataStoresId,
+projectsId,
+description,
+updateTime,
+displayName,
+parentContexts,
+createTime,
+labels,
+name,
+schemaTitle,
+metadata,
+etag,
+schemaVersion
+)
+SELECT
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ description }}',
+'{{ updateTime }}',
+'{{ displayName }}',
+'{{ parentContexts }}',
+'{{ createTime }}',
+'{{ labels }}',
+'{{ name }}',
+'{{ schemaTitle }}',
+'{{ metadata }}',
+'{{ etag }}',
+'{{ schemaVersion }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: description
+ value: '{{ description }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: parentContexts
+ value: '{{ parentContexts }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: name
+ value: '{{ name }}'
+ - name: schemaTitle
+ value: '{{ schemaTitle }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: schemaVersion
+ value: '{{ schemaVersion }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a context only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.contexts
+SET
+description = '{{ description }}',
+updateTime = '{{ updateTime }}',
+displayName = '{{ displayName }}',
+parentContexts = '{{ parentContexts }}',
+createTime = '{{ createTime }}',
+labels = '{{ labels }}',
+name = '{{ name }}',
+schemaTitle = '{{ schemaTitle }}',
+metadata = '{{ metadata }}',
+etag = '{{ etag }}',
+schemaVersion = '{{ schemaVersion }}'
+WHERE
+contextsId = '{{ contextsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified context resource.
+
+```sql
+DELETE FROM google.aiplatform.contexts
+WHERE contextsId = '{{ contextsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md b/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md
index 396ae4d7c4..a9552bfee8 100644
--- a/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md
+++ b/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md
@@ -1,3 +1,4 @@
+
---
title: contexts_context_artifacts_and_executions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- contexts_context_artifacts_and_executions
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an contexts_context_artifacts_and_execution
resource or lists contexts_context_artifacts_and_executions
in a region
## Overview
@@ -28,8 +30,58 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new contexts_context_artifacts_and_executions
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.contexts_context_artifacts_and_executions (
+contextsId,
+locationsId,
+metadataStoresId,
+projectsId,
+artifacts,
+executions
+)
+SELECT
+'{{ contextsId }}',
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ artifacts }}',
+'{{ executions }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: artifacts
+ value: '{{ artifacts }}'
+ - name: executions
+ value: '{{ executions }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md b/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md
index cf5aeeed7b..ca5575ad5c 100644
--- a/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md
+++ b/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md
@@ -1,3 +1,4 @@
+
---
title: contexts_context_children
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- contexts_context_children
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an contexts_context_child
resource or lists contexts_context_children
in a region
## Overview
@@ -28,9 +30,67 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
-| | `EXEC` | | Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. |
-| | `EXEC` | | Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. |
+| | `INSERT` | | Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. |
+| | `DELETE` | | Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new contexts_context_children
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.contexts_context_children (
+contextsId,
+locationsId,
+metadataStoresId,
+projectsId,
+childContexts
+)
+SELECT
+'{{ contextsId }}',
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ childContexts }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: childContexts
+ value: '{{ childContexts }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified contexts_context_child resource.
+
+```sql
+DELETE FROM google.aiplatform.contexts_context_children
+WHERE contextsId = '{{ contextsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md
index 485beed08f..cab6c9d99e 100644
--- a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: custom_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- custom_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an custom_job
resource or lists custom_jobs
in a region
## Overview
@@ -38,10 +40,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | 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). |
| | `object` | Represents the spec of a CustomJob. |
| | `object` | The labels with user-defined metadata to organize CustomJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. |
| | `string` | Output only. The detailed state of the job. |
| | `string` | Output only. Time when the CustomJob was most recently updated. |
| | `object` | Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if job_spec.enable_web_access is `true`. The keys are names of each node in the training job; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -49,5 +54,132 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists CustomJobs in a Location. |
| | `INSERT` | | Creates a CustomJob. A created CustomJob right away will be attempted to be run. |
| | `DELETE` | | Deletes a CustomJob. |
-| | `EXEC` | | Lists CustomJobs in a Location. |
| | `EXEC` | | Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists CustomJobs in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+encryptionSpec,
+endTime,
+error,
+jobSpec,
+labels,
+satisfiesPzi,
+satisfiesPzs,
+startTime,
+state,
+updateTime,
+webAccessUris
+FROM google.aiplatform.custom_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new custom_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.custom_jobs (
+locationsId,
+projectsId,
+satisfiesPzs,
+displayName,
+encryptionSpec,
+webAccessUris,
+updateTime,
+state,
+error,
+satisfiesPzi,
+createTime,
+labels,
+name,
+jobSpec,
+endTime,
+startTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+true|false,
+'{{ displayName }}',
+'{{ encryptionSpec }}',
+'{{ webAccessUris }}',
+'{{ updateTime }}',
+'{{ state }}',
+'{{ error }}',
+true|false,
+'{{ createTime }}',
+'{{ labels }}',
+'{{ name }}',
+'{{ jobSpec }}',
+'{{ endTime }}',
+'{{ startTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: webAccessUris
+ value: '{{ webAccessUris }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: state
+ value: '{{ state }}'
+ - name: error
+ value: '{{ error }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: name
+ value: '{{ name }}'
+ - name: jobSpec
+ value: '{{ jobSpec }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: startTime
+ value: '{{ startTime }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified custom_job resource.
+
+```sql
+DELETE FROM google.aiplatform.custom_jobs
+WHERE customJobsId = '{{ customJobsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/data_items/index.md b/docs/google-docs/providers/google/aiplatform/data_items/index.md
index 6171d372c2..320742ac6e 100644
--- a/docs/google-docs/providers/google/aiplatform/data_items/index.md
+++ b/docs/google-docs/providers/google/aiplatform/data_items/index.md
@@ -1,3 +1,4 @@
+
---
title: data_items
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data_items
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an data_item
resource or lists data_items
in a region
## Overview
@@ -35,9 +37,31 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `any` | Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this DataItem was last updated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists DataItems in a Dataset. |
+
+## `SELECT` examples
+
+Lists DataItems in a Dataset.
+
+```sql
+SELECT
+name,
+createTime,
+etag,
+labels,
+payload,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.data_items
+WHERE datasetsId = '{{ datasetsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md
index ef20d81cbb..71e52f0318 100644
--- a/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: data_labeling_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data_labeling_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an data_labeling_job
resource or lists data_labeling_jobs
in a region
## Overview
@@ -35,7 +37,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `string` | Output only. Timestamp when this DataLabelingJob was created. |
| | `object` | Represents an amount of money with its currency type. |
-| | `array` | Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` |
+| | `array` | Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` |
| | `string` | Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob. |
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `object` | 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). |
@@ -48,6 +50,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | The SpecialistPools' resource names associated with this job. |
| | `string` | Output only. The detailed state of the job. |
| | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -55,5 +58,152 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists DataLabelingJobs in a Location. |
| | `INSERT` | | Creates a DataLabelingJob. |
| | `DELETE` | | Deletes a DataLabelingJob. |
-| | `EXEC` | | Lists DataLabelingJobs in a Location. |
| | `EXEC` | | Cancels a DataLabelingJob. Success of cancellation is not guaranteed. |
+
+## `SELECT` examples
+
+Lists DataLabelingJobs in a Location.
+
+```sql
+SELECT
+name,
+activeLearningConfig,
+annotationLabels,
+createTime,
+currentSpend,
+datasets,
+displayName,
+encryptionSpec,
+error,
+inputs,
+inputsSchemaUri,
+instructionUri,
+labelerCount,
+labelingProgress,
+labels,
+specialistPools,
+state,
+updateTime
+FROM google.aiplatform.data_labeling_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new data_labeling_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.data_labeling_jobs (
+locationsId,
+projectsId,
+createTime,
+displayName,
+encryptionSpec,
+labelerCount,
+annotationLabels,
+updateTime,
+inputsSchemaUri,
+inputs,
+datasets,
+labels,
+name,
+state,
+currentSpend,
+activeLearningConfig,
+labelingProgress,
+instructionUri,
+specialistPools,
+error
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ createTime }}',
+'{{ displayName }}',
+'{{ encryptionSpec }}',
+'{{ labelerCount }}',
+'{{ annotationLabels }}',
+'{{ updateTime }}',
+'{{ inputsSchemaUri }}',
+'{{ inputs }}',
+'{{ datasets }}',
+'{{ labels }}',
+'{{ name }}',
+'{{ state }}',
+'{{ currentSpend }}',
+'{{ activeLearningConfig }}',
+'{{ labelingProgress }}',
+'{{ instructionUri }}',
+'{{ specialistPools }}',
+'{{ error }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: labelerCount
+ value: '{{ labelerCount }}'
+ - name: annotationLabels
+ value: '{{ annotationLabels }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: inputsSchemaUri
+ value: '{{ inputsSchemaUri }}'
+ - name: inputs
+ value: '{{ inputs }}'
+ - name: datasets
+ value: '{{ datasets }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: name
+ value: '{{ name }}'
+ - name: state
+ value: '{{ state }}'
+ - name: currentSpend
+ value: '{{ currentSpend }}'
+ - name: activeLearningConfig
+ value: '{{ activeLearningConfig }}'
+ - name: labelingProgress
+ value: '{{ labelingProgress }}'
+ - name: instructionUri
+ value: '{{ instructionUri }}'
+ - name: specialistPools
+ value: '{{ specialistPools }}'
+ - name: error
+ value: '{{ error }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified data_labeling_job resource.
+
+```sql
+DELETE FROM google.aiplatform.data_labeling_jobs
+WHERE dataLabelingJobsId = '{{ dataLabelingJobsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md b/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md
index de1154e724..e454d8747f 100644
--- a/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md
+++ b/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md
@@ -1,3 +1,4 @@
+
---
title: dataset_versions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- dataset_versions
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an dataset_version
resource or lists dataset_versions
in a region
## Overview
@@ -30,21 +32,149 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The resource name of the DatasetVersion. |
+| | `string` | Output only. Identifier. The resource name of the DatasetVersion. |
| | `string` | Output only. Name of the associated BigQuery dataset. |
| | `string` | Output only. Timestamp when this DatasetVersion was created. |
| | `string` | The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `any` | Required. Output only. Additional information about the DatasetVersion. |
| | `string` | Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this DatasetVersion was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
-| | `SELECT` | | Gets a Dataset version. |
-| | `SELECT` | | Lists DatasetVersions in a Dataset. |
-| | `INSERT` | | Create a version from a Dataset. |
-| | `DELETE` | | Deletes a Dataset version. |
-| | `UPDATE` | | Updates a DatasetVersion. |
-| | `EXEC` | | Lists DatasetVersions in a Dataset. |
-| | `EXEC` | | Restores a dataset version. |
+| | `SELECT` | | Gets a Dataset version. |
+| | `SELECT` | | Lists DatasetVersions in a Dataset. |
+| | `INSERT` | | Create a version from a Dataset. |
+| | `DELETE` | | Deletes a Dataset version. |
+| | `UPDATE` | | Updates a DatasetVersion. |
+| | `EXEC` | | Restores a dataset version. |
+
+## `SELECT` examples
+
+Lists DatasetVersions in a Dataset.
+
+```sql
+SELECT
+name,
+bigQueryDatasetName,
+createTime,
+displayName,
+etag,
+metadata,
+modelReference,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.dataset_versions
+WHERE datasetsId = '{{ datasetsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new dataset_versions
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.dataset_versions (
+datasetsId,
+etag,
+satisfiesPzi,
+createTime,
+updateTime,
+bigQueryDatasetName,
+modelReference,
+name,
+metadata,
+displayName,
+satisfiesPzs
+)
+SELECT
+'{{ datasetsId }}',
+'{{ etag }}',
+true|false,
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ bigQueryDatasetName }}',
+'{{ modelReference }}',
+'{{ name }}',
+'{{ metadata }}',
+'{{ displayName }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: etag
+ value: '{{ etag }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: bigQueryDatasetName
+ value: '{{ bigQueryDatasetName }}'
+ - name: modelReference
+ value: '{{ modelReference }}'
+ - name: name
+ value: '{{ name }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a dataset_version only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.dataset_versions
+SET
+etag = '{{ etag }}',
+satisfiesPzi = true|false,
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+bigQueryDatasetName = '{{ bigQueryDatasetName }}',
+modelReference = '{{ modelReference }}',
+name = '{{ name }}',
+metadata = '{{ metadata }}',
+displayName = '{{ displayName }}',
+satisfiesPzs = true|false
+WHERE
+datasetVersionsId = '{{ datasetVersionsId }}'
+AND datasetsId = '{{ datasetsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified dataset_version resource.
+
+```sql
+DELETE FROM google.aiplatform.dataset_versions
+WHERE datasetVersionsId = '{{ datasetVersionsId }}'
+AND datasetsId = '{{ datasetsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/datasets/index.md b/docs/google-docs/providers/google/aiplatform/datasets/index.md
index 4f786ce352..c0df832dfd 100644
--- a/docs/google-docs/providers/google/aiplatform/datasets/index.md
+++ b/docs/google-docs/providers/google/aiplatform/datasets/index.md
@@ -1,3 +1,4 @@
+
---
title: datasets
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- datasets
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an dataset
resource or lists datasets
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The resource name of the Dataset. |
+| | `string` | Output only. Identifier. The resource name of the Dataset. |
| | `string` | The description of the Dataset. |
| | `string` | Output only. Timestamp when this Dataset was created. |
| | `string` | Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset. |
@@ -39,20 +41,182 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title. |
| | `any` | Required. Additional information about the Dataset. |
-| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
+| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
| | `string` | Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. |
| | `string` | Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `array` | All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. |
| | `string` | Output only. Timestamp when this Dataset was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
-| | `SELECT` | | Gets a Dataset. |
-| | `SELECT` | | Lists Datasets in a Location. |
-| | `INSERT` | | Creates a Dataset. |
-| | `DELETE` | | Deletes a Dataset. |
-| | `UPDATE` | | Updates a Dataset. |
-| | `EXEC` | | Lists Datasets in a Location. |
+| | `SELECT` | | Gets a Dataset. |
+| | `SELECT` | | Lists Datasets in a Location. |
+| | `INSERT` | | Creates a Dataset. |
+| | `DELETE` | | Deletes a Dataset. |
+| | `UPDATE` | | Updates a Dataset. |
| | `EXEC` | | Exports data from a Dataset. |
| | `EXEC` | | Imports data into a Dataset. |
| | `EXEC` | | Searches DataItems in a Dataset. |
+
+## `SELECT` examples
+
+Lists Datasets in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+dataItemCount,
+displayName,
+encryptionSpec,
+etag,
+labels,
+metadata,
+metadataArtifact,
+metadataSchemaUri,
+modelReference,
+satisfiesPzi,
+satisfiesPzs,
+savedQueries,
+updateTime
+FROM google.aiplatform.datasets
+WHERE = '{{ }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new datasets
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.datasets (
+,
+metadataSchemaUri,
+updateTime,
+satisfiesPzi,
+metadataArtifact,
+description,
+createTime,
+satisfiesPzs,
+metadata,
+etag,
+displayName,
+dataItemCount,
+name,
+labels,
+modelReference,
+encryptionSpec,
+savedQueries
+)
+SELECT
+'{{ }}',
+'{{ metadataSchemaUri }}',
+'{{ updateTime }}',
+true|false,
+'{{ metadataArtifact }}',
+'{{ description }}',
+'{{ createTime }}',
+true|false,
+'{{ metadata }}',
+'{{ etag }}',
+'{{ displayName }}',
+'{{ dataItemCount }}',
+'{{ name }}',
+'{{ labels }}',
+'{{ modelReference }}',
+'{{ encryptionSpec }}',
+'{{ savedQueries }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: metadataSchemaUri
+ value: '{{ metadataSchemaUri }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: metadataArtifact
+ value: '{{ metadataArtifact }}'
+ - name: description
+ value: '{{ description }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: dataItemCount
+ value: '{{ dataItemCount }}'
+ - name: name
+ value: '{{ name }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: modelReference
+ value: '{{ modelReference }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: savedQueries
+ value: '{{ savedQueries }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a dataset only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.datasets
+SET
+metadataSchemaUri = '{{ metadataSchemaUri }}',
+updateTime = '{{ updateTime }}',
+satisfiesPzi = true|false,
+metadataArtifact = '{{ metadataArtifact }}',
+description = '{{ description }}',
+createTime = '{{ createTime }}',
+satisfiesPzs = true|false,
+metadata = '{{ metadata }}',
+etag = '{{ etag }}',
+displayName = '{{ displayName }}',
+dataItemCount = '{{ dataItemCount }}',
+name = '{{ name }}',
+labels = '{{ labels }}',
+modelReference = '{{ modelReference }}',
+encryptionSpec = '{{ encryptionSpec }}',
+savedQueries = '{{ savedQueries }}'
+WHERE
+datasetsId = '{{ datasetsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified dataset resource.
+
+```sql
+DELETE FROM google.aiplatform.datasets
+WHERE datasetsId = '{{ datasetsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md b/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md
index fe9e50b5e0..5da6d19de0 100644
--- a/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md
+++ b/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md
@@ -1,3 +1,4 @@
+
---
title: deployment_resource_pools
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- deployment_resource_pools
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an deployment_resource_pool
resource or lists deployment_resource_pools
in a region
## Overview
@@ -30,18 +32,116 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` |
+| | `string` | Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` |
| | `string` | Output only. Timestamp when this DeploymentResourcePool was created. |
| | `object` | A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. |
| | `boolean` | If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. |
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Get a DeploymentResourcePool. |
| | `SELECT` | | List DeploymentResourcePools in a location. |
+| | `SELECT` | | List DeployedModels that have been deployed on this DeploymentResourcePool. |
| | `INSERT` | | Create a DeploymentResourcePool. |
| | `DELETE` | | Delete a DeploymentResourcePool. |
-| | `EXEC` | | List DeploymentResourcePools in a location. |
-| | `EXEC` | | List DeployedModels that have been deployed on this DeploymentResourcePool. |
+| | `UPDATE` | | Update a DeploymentResourcePool. |
+
+## `SELECT` examples
+
+List DeploymentResourcePools in a location.
+
+```sql
+SELECT
+name,
+createTime,
+dedicatedResources,
+disableContainerLogging,
+encryptionSpec,
+satisfiesPzi,
+satisfiesPzs,
+serviceAccount
+FROM google.aiplatform.deployment_resource_pools
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new deployment_resource_pools
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.deployment_resource_pools (
+locationsId,
+projectsId,
+deploymentResourcePoolId,
+deploymentResourcePool
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ deploymentResourcePoolId }}',
+'{{ deploymentResourcePool }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: deploymentResourcePoolId
+ value: '{{ deploymentResourcePoolId }}'
+ - name: deploymentResourcePool
+ value: '{{ deploymentResourcePool }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a deployment_resource_pool only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.deployment_resource_pools
+SET
+serviceAccount = '{{ serviceAccount }}',
+dedicatedResources = '{{ dedicatedResources }}',
+disableContainerLogging = true|false,
+encryptionSpec = '{{ encryptionSpec }}',
+createTime = '{{ createTime }}',
+satisfiesPzs = true|false,
+satisfiesPzi = true|false,
+name = '{{ name }}'
+WHERE
+deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified deployment_resource_pool resource.
+
+```sql
+DELETE FROM google.aiplatform.deployment_resource_pools
+WHERE deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/endpoints/index.md b/docs/google-docs/providers/google/aiplatform/endpoints/index.md
index 5fe608d97d..e15c68e4ba 100644
--- a/docs/google-docs/providers/google/aiplatform/endpoints/index.md
+++ b/docs/google-docs/providers/google/aiplatform/endpoints/index.md
@@ -1,3 +1,4 @@
+
---
title: endpoints
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- endpoints
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an endpoint
resource or lists endpoints
in a region
## Overview
@@ -33,18 +35,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The resource name of the Endpoint. |
| | `string` | The description of the Endpoint. |
| | `string` | Output only. Timestamp when this Endpoint was created. |
+| | `string` | Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. |
+| | `boolean` | If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. |
| | `array` | Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. |
| | `string` | Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| | `boolean` | Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. |
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
-| | `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}` |
-| | `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. |
+| | `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}` |
+| | `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. |
| | `object` | Configuration for logging request-response to a BigQuery table. |
| | `object` | Represents configuration for private service connect. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `object` | A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. |
| | `string` | Output only. Timestamp when this Endpoint was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -53,18 +60,202 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an Endpoint. |
| | `DELETE` | | Deletes an Endpoint. |
| | `UPDATE` | | Updates an Endpoint. |
-| | `EXEC` | | Lists Endpoints in a Location. |
-| | `EXEC` | | Return a list of tokens based on the input text. |
-| | `EXEC` | | Perform a token counting. |
+| | `EXEC` | | Return a list of tokens based on the input text. |
+| | `EXEC` | | Perform a token counting. |
| | `EXEC` | | Deploys a Model into this Endpoint, creating a DeployedModel within it. |
| | `EXEC` | | Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. |
| | `EXEC` | | Perform an unary online prediction request to a gRPC model server for custom containers. |
| | `EXEC` | | Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated. |
-| | `EXEC` | | Generate content with multimodal inputs. |
+| | `EXEC` | | Generate content with multimodal inputs. |
| | `EXEC` | | Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only). |
| | `EXEC` | | Perform an online prediction. |
| | `EXEC` | | Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. |
| | `EXEC` | | Perform a server-side streaming online prediction request for Vertex LLM streaming. |
-| | `EXEC` | | Generate content with multimodal inputs with streaming support. |
+| | `EXEC` | | Generate content with multimodal inputs with streaming support. |
| | `EXEC` | | Perform a streaming online prediction with an arbitrary HTTP payload. |
| | `EXEC` | | Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. |
+
+## `SELECT` examples
+
+Lists Endpoints in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+dedicatedEndpointDns,
+dedicatedEndpointEnabled,
+deployedModels,
+displayName,
+enablePrivateServiceConnect,
+encryptionSpec,
+etag,
+labels,
+modelDeploymentMonitoringJob,
+network,
+predictRequestResponseLoggingConfig,
+privateServiceConnectConfig,
+satisfiesPzi,
+satisfiesPzs,
+trafficSplit,
+updateTime
+FROM google.aiplatform.endpoints
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new endpoints
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.endpoints (
+locationsId,
+projectsId,
+dedicatedEndpointDns,
+displayName,
+trafficSplit,
+predictRequestResponseLoggingConfig,
+updateTime,
+privateServiceConnectConfig,
+encryptionSpec,
+etag,
+name,
+enablePrivateServiceConnect,
+modelDeploymentMonitoringJob,
+labels,
+deployedModels,
+satisfiesPzs,
+network,
+satisfiesPzi,
+description,
+createTime,
+dedicatedEndpointEnabled
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ dedicatedEndpointDns }}',
+'{{ displayName }}',
+'{{ trafficSplit }}',
+'{{ predictRequestResponseLoggingConfig }}',
+'{{ updateTime }}',
+'{{ privateServiceConnectConfig }}',
+'{{ encryptionSpec }}',
+'{{ etag }}',
+'{{ name }}',
+true|false,
+'{{ modelDeploymentMonitoringJob }}',
+'{{ labels }}',
+'{{ deployedModels }}',
+true|false,
+'{{ network }}',
+true|false,
+'{{ description }}',
+'{{ createTime }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: dedicatedEndpointDns
+ value: '{{ dedicatedEndpointDns }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: trafficSplit
+ value: '{{ trafficSplit }}'
+ - name: predictRequestResponseLoggingConfig
+ value: '{{ predictRequestResponseLoggingConfig }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: privateServiceConnectConfig
+ value: '{{ privateServiceConnectConfig }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: name
+ value: '{{ name }}'
+ - name: enablePrivateServiceConnect
+ value: '{{ enablePrivateServiceConnect }}'
+ - name: modelDeploymentMonitoringJob
+ value: '{{ modelDeploymentMonitoringJob }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: deployedModels
+ value: '{{ deployedModels }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: network
+ value: '{{ network }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: description
+ value: '{{ description }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: dedicatedEndpointEnabled
+ value: '{{ dedicatedEndpointEnabled }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a endpoint only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.endpoints
+SET
+dedicatedEndpointDns = '{{ dedicatedEndpointDns }}',
+displayName = '{{ displayName }}',
+trafficSplit = '{{ trafficSplit }}',
+predictRequestResponseLoggingConfig = '{{ predictRequestResponseLoggingConfig }}',
+updateTime = '{{ updateTime }}',
+privateServiceConnectConfig = '{{ privateServiceConnectConfig }}',
+encryptionSpec = '{{ encryptionSpec }}',
+etag = '{{ etag }}',
+name = '{{ name }}',
+enablePrivateServiceConnect = true|false,
+modelDeploymentMonitoringJob = '{{ modelDeploymentMonitoringJob }}',
+labels = '{{ labels }}',
+deployedModels = '{{ deployedModels }}',
+satisfiesPzs = true|false,
+network = '{{ network }}',
+satisfiesPzi = true|false,
+description = '{{ description }}',
+createTime = '{{ createTime }}',
+dedicatedEndpointEnabled = true|false
+WHERE
+endpointsId = '{{ endpointsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified endpoint resource.
+
+```sql
+DELETE FROM google.aiplatform.endpoints
+WHERE endpointsId = '{{ endpointsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/entity_types/index.md b/docs/google-docs/providers/google/aiplatform/entity_types/index.md
index bf8911e4c0..23c4aea93c 100644
--- a/docs/google-docs/providers/google/aiplatform/entity_types/index.md
+++ b/docs/google-docs/providers/google/aiplatform/entity_types/index.md
@@ -1,3 +1,4 @@
+
---
title: entity_types
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- entity_types
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an entity_type
resource or lists entity_types
in a region
## Overview
@@ -30,14 +32,17 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. |
+| | `string` | Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. |
| | `string` | Optional. Description of the EntityType. |
| | `string` | Output only. Timestamp when this EntityType was created. |
| | `string` | Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | Optional. The labels with user-defined metadata to organize your EntityTypes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one EntityType (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `object` | Configuration of how features in Featurestore are monitored. |
| | `integer` | Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this EntityType was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -46,9 +51,144 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new EntityType in a given Featurestore. |
| | `DELETE` | | Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. |
| | `UPDATE` | | Updates the parameters of a single EntityType. |
-| | `EXEC` | | Lists EntityTypes in a given Featurestore. |
| | `EXEC` | | Exports Feature values from all the entities of a target EntityType. |
| | `EXEC` | | Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. |
| | `EXEC` | | Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. |
| | `EXEC` | | Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. |
| | `EXEC` | | Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. |
+
+## `SELECT` examples
+
+Lists EntityTypes in a given Featurestore.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+etag,
+labels,
+monitoringConfig,
+offlineStorageTtlDays,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.entity_types
+WHERE featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new entity_types
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.entity_types (
+featurestoresId,
+locationsId,
+projectsId,
+etag,
+createTime,
+name,
+satisfiesPzi,
+updateTime,
+offlineStorageTtlDays,
+description,
+satisfiesPzs,
+monitoringConfig,
+labels
+)
+SELECT
+'{{ featurestoresId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ etag }}',
+'{{ createTime }}',
+'{{ name }}',
+true|false,
+'{{ updateTime }}',
+'{{ offlineStorageTtlDays }}',
+'{{ description }}',
+true|false,
+'{{ monitoringConfig }}',
+'{{ labels }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: etag
+ value: '{{ etag }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: name
+ value: '{{ name }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: offlineStorageTtlDays
+ value: '{{ offlineStorageTtlDays }}'
+ - name: description
+ value: '{{ description }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: monitoringConfig
+ value: '{{ monitoringConfig }}'
+ - name: labels
+ value: '{{ labels }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a entity_type only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.entity_types
+SET
+etag = '{{ etag }}',
+createTime = '{{ createTime }}',
+name = '{{ name }}',
+satisfiesPzi = true|false,
+updateTime = '{{ updateTime }}',
+offlineStorageTtlDays = '{{ offlineStorageTtlDays }}',
+description = '{{ description }}',
+satisfiesPzs = true|false,
+monitoringConfig = '{{ monitoringConfig }}',
+labels = '{{ labels }}'
+WHERE
+entityTypesId = '{{ entityTypesId }}'
+AND featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified entity_type resource.
+
+```sql
+DELETE FROM google.aiplatform.entity_types
+WHERE entityTypesId = '{{ entityTypesId }}'
+AND featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md b/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md
index 8d01132355..0c00d82b55 100644
--- a/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md
+++ b/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md
@@ -1,3 +1,4 @@
+
---
title: entity_types_feature_values
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- entity_types_feature_values
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an entity_types_feature_value
resource or lists entity_types_feature_values
in a region
## Overview
@@ -28,8 +30,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `DELETE` | | Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. |
+
+## `DELETE` example
+
+Deletes the specified entity_types_feature_value resource.
+
+```sql
+DELETE FROM google.aiplatform.entity_types_feature_values
+WHERE entityTypesId = '{{ entityTypesId }}'
+AND featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md
index 59f7f0ef4b..af8a120afc 100644
--- a/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md
+++ b/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: entity_types_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- entity_types_iam_policies
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an entity_types_iam_policy
resource or lists entity_types_iam_policies
in a region
## Overview
@@ -30,13 +32,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.entity_types_iam_policies
+WHERE entityTypesId = '{{ entityTypesId }}'
+AND featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/evaluations/index.md b/docs/google-docs/providers/google/aiplatform/evaluations/index.md
index b249d46fcb..f2ff9af7de 100644
--- a/docs/google-docs/providers/google/aiplatform/evaluations/index.md
+++ b/docs/google-docs/providers/google/aiplatform/evaluations/index.md
@@ -1,3 +1,4 @@
+
---
title: evaluations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- evaluations
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an evaluation
resource or lists evaluations
in a region
## Overview
@@ -41,10 +43,33 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). |
| | `object` | Aggregated explanation metrics for a Model over a set of instances. |
| | `array` | All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of `slice.dimension = `. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a ModelEvaluation. |
| | `SELECT` | | Lists ModelEvaluations in a Model. |
-| | `EXEC` | | Lists ModelEvaluations in a Model. |
| | `EXEC` | | Imports an externally generated ModelEvaluation. |
+
+## `SELECT` examples
+
+Lists ModelEvaluations in a Model.
+
+```sql
+SELECT
+name,
+annotationSchemaUri,
+createTime,
+dataItemSchemaUri,
+displayName,
+explanationSpecs,
+metadata,
+metrics,
+metricsSchemaUri,
+modelExplanation,
+sliceDimensions
+FROM google.aiplatform.evaluations
+WHERE locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/executions/index.md b/docs/google-docs/providers/google/aiplatform/executions/index.md
index dca046f1da..0035eb6fb6 100644
--- a/docs/google-docs/providers/google/aiplatform/executions/index.md
+++ b/docs/google-docs/providers/google/aiplatform/executions/index.md
@@ -1,3 +1,4 @@
+
---
title: executions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- executions
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an execution
resource or lists executions
in a region
## Overview
@@ -30,25 +32,151 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The resource name of the Execution. |
-| | `string` | Description of the Execution |
-| | `string` | Output only. Timestamp when this Execution was created. |
-| | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. |
-| | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
-| | `object` | The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded). |
-| | `object` | Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. |
-| | `string` | The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
-| | `string` | The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. |
-| | `string` | The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions. |
-| | `string` | Output only. Timestamp when this Execution was last updated. |
+| | `array` | The Artifact nodes in the subgraph. |
+| | `array` | The Event edges between Artifacts and Executions in the subgraph. |
+| | `array` | The Execution nodes in the subgraph. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Retrieves a specific Execution. |
| | `SELECT` | | Lists Executions in the MetadataStore. |
+| | `SELECT` | | Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. |
| | `INSERT` | | Creates an Execution associated with a MetadataStore. |
| | `DELETE` | | Deletes an Execution. |
| | `UPDATE` | | Updates a stored Execution. |
-| | `EXEC` | | Lists Executions in the MetadataStore. |
| | `EXEC` | | Purges Executions. |
-| | `EXEC` | | Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. |
+
+## `SELECT` examples
+
+Lists Executions in the MetadataStore.
+
+```sql
+SELECT
+artifacts,
+events,
+executions
+FROM google.aiplatform.executions
+WHERE locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new executions
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.executions (
+locationsId,
+metadataStoresId,
+projectsId,
+name,
+description,
+state,
+labels,
+createTime,
+displayName,
+schemaVersion,
+schemaTitle,
+etag,
+updateTime,
+metadata
+)
+SELECT
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ description }}',
+'{{ state }}',
+'{{ labels }}',
+'{{ createTime }}',
+'{{ displayName }}',
+'{{ schemaVersion }}',
+'{{ schemaTitle }}',
+'{{ etag }}',
+'{{ updateTime }}',
+'{{ metadata }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: description
+ value: '{{ description }}'
+ - name: state
+ value: '{{ state }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: schemaVersion
+ value: '{{ schemaVersion }}'
+ - name: schemaTitle
+ value: '{{ schemaTitle }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: metadata
+ value: '{{ metadata }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a execution only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.executions
+SET
+name = '{{ name }}',
+description = '{{ description }}',
+state = '{{ state }}',
+labels = '{{ labels }}',
+createTime = '{{ createTime }}',
+displayName = '{{ displayName }}',
+schemaVersion = '{{ schemaVersion }}',
+schemaTitle = '{{ schemaTitle }}',
+etag = '{{ etag }}',
+updateTime = '{{ updateTime }}',
+metadata = '{{ metadata }}'
+WHERE
+executionsId = '{{ executionsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified execution resource.
+
+```sql
+DELETE FROM google.aiplatform.executions
+WHERE executionsId = '{{ executionsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md b/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md
index 61423526f2..6e719b974e 100644
--- a/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md
+++ b/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md
@@ -1,3 +1,4 @@
+
---
title: executions_execution_events
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- executions_execution_events
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an executions_execution_event
resource or lists executions_execution_events
in a region
## Overview
@@ -28,8 +30,54 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new executions_execution_events
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.executions_execution_events (
+executionsId,
+locationsId,
+metadataStoresId,
+projectsId,
+events
+)
+SELECT
+'{{ executionsId }}',
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ events }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: events
+ value: '{{ events }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/aiplatform/experiments/index.md b/docs/google-docs/providers/google/aiplatform/experiments/index.md
index 76c61cd52f..90423a146c 100644
--- a/docs/google-docs/providers/google/aiplatform/experiments/index.md
+++ b/docs/google-docs/providers/google/aiplatform/experiments/index.md
@@ -1,3 +1,4 @@
+
---
title: experiments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- experiments
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an experiment
resource or lists experiments
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` |
+| | `string` | Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` |
| | `string` | Description of this TensorboardExperiment. |
| | `string` | Output only. Timestamp when this TensorboardExperiment was created. |
| | `string` | User provided name of this TensorboardExperiment. |
@@ -38,14 +40,138 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `aiplatform.googleapis.com/` and are immutable. The following system labels exist for each Dataset: * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its value is the metadata_schema's title. |
| | `string` | Immutable. Source of the TensorboardExperiment. Example: a custom training job. |
| | `string` | Output only. Timestamp when this TensorboardExperiment was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a TensorboardExperiment. |
| | `SELECT` | | Lists TensorboardExperiments in a Location. |
+| | `INSERT` | | Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. |
| | `INSERT` | | Creates a TensorboardExperiment. |
| | `DELETE` | | Deletes a TensorboardExperiment. |
| | `UPDATE` | | Updates a TensorboardExperiment. |
-| | `EXEC` | | Lists TensorboardExperiments in a Location. |
-| | `EXEC` | | Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. |
| | `EXEC` | | Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. |
+
+## `SELECT` examples
+
+Lists TensorboardExperiments in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+etag,
+labels,
+source,
+updateTime
+FROM google.aiplatform.experiments
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new experiments
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.experiments (
+locationsId,
+projectsId,
+tensorboardsId,
+labels,
+displayName,
+updateTime,
+source,
+createTime,
+etag,
+name,
+description
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ tensorboardsId }}',
+'{{ labels }}',
+'{{ displayName }}',
+'{{ updateTime }}',
+'{{ source }}',
+'{{ createTime }}',
+'{{ etag }}',
+'{{ name }}',
+'{{ description }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: labels
+ value: '{{ labels }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: source
+ value: '{{ source }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: name
+ value: '{{ name }}'
+ - name: description
+ value: '{{ description }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a experiment only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.experiments
+SET
+labels = '{{ labels }}',
+displayName = '{{ displayName }}',
+updateTime = '{{ updateTime }}',
+source = '{{ source }}',
+createTime = '{{ createTime }}',
+etag = '{{ etag }}',
+name = '{{ name }}',
+description = '{{ description }}'
+WHERE
+experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified experiment resource.
+
+```sql
+DELETE FROM google.aiplatform.experiments
+WHERE experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_groups/index.md b/docs/google-docs/providers/google/aiplatform/feature_groups/index.md
index f9c2e6b645..963348e3b7 100644
--- a/docs/google-docs/providers/google/aiplatform/feature_groups/index.md
+++ b/docs/google-docs/providers/google/aiplatform/feature_groups/index.md
@@ -1,3 +1,4 @@
+
---
title: feature_groups
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- feature_groups
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature_group
resource or lists feature_groups
in a region
## Overview
@@ -30,13 +32,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}` |
+| | `string` | Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}` |
| | `string` | Optional. Description of the FeatureGroup. |
| | `object` | Input source type for BigQuery Tables and Views. |
| | `string` | Output only. Timestamp when this FeatureGroup was created. |
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `string` | Output only. Timestamp when this FeatureGroup was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -45,4 +48,116 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new FeatureGroup in a given project and location. |
| | `DELETE` | | Deletes a single FeatureGroup. |
| | `UPDATE` | | Updates the parameters of a single FeatureGroup. |
-| | `EXEC` | | Lists FeatureGroups in a given project and location. |
+
+## `SELECT` examples
+
+Lists FeatureGroups in a given project and location.
+
+```sql
+SELECT
+name,
+description,
+bigQuery,
+createTime,
+etag,
+labels,
+updateTime
+FROM google.aiplatform.feature_groups
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new feature_groups
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.feature_groups (
+locationsId,
+projectsId,
+bigQuery,
+updateTime,
+name,
+description,
+labels,
+createTime,
+etag
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ bigQuery }}',
+'{{ updateTime }}',
+'{{ name }}',
+'{{ description }}',
+'{{ labels }}',
+'{{ createTime }}',
+'{{ etag }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: bigQuery
+ value: '{{ bigQuery }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: name
+ value: '{{ name }}'
+ - name: description
+ value: '{{ description }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: etag
+ value: '{{ etag }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a feature_group only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.feature_groups
+SET
+bigQuery = '{{ bigQuery }}',
+updateTime = '{{ updateTime }}',
+name = '{{ name }}',
+description = '{{ description }}',
+labels = '{{ labels }}',
+createTime = '{{ createTime }}',
+etag = '{{ etag }}'
+WHERE
+featureGroupsId = '{{ featureGroupsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified feature_group resource.
+
+```sql
+DELETE FROM google.aiplatform.feature_groups
+WHERE featureGroupsId = '{{ featureGroupsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md b/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md
index d3b22fe240..1c651bbe09 100644
--- a/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md
+++ b/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md
@@ -1,3 +1,4 @@
+
---
title: feature_online_stores
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- feature_online_stores
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature_online_store
resource or lists feature_online_stores
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` |
+| | `string` | Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` |
| | `object` | |
| | `string` | Output only. Timestamp when this FeatureOnlineStore was created. |
| | `object` | The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. |
@@ -38,8 +40,11 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `object` | Optimized storage type |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. State of the featureOnlineStore. |
| | `string` | Output only. Timestamp when this FeatureOnlineStore was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -48,4 +53,146 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new FeatureOnlineStore in a given project and location. |
| | `DELETE` | | Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. |
| | `UPDATE` | | Updates the parameters of a single FeatureOnlineStore. |
-| | `EXEC` | | Lists FeatureOnlineStores in a given project and location. |
+
+## `SELECT` examples
+
+Lists FeatureOnlineStores in a given project and location.
+
+```sql
+SELECT
+name,
+bigtable,
+createTime,
+dedicatedServingEndpoint,
+encryptionSpec,
+etag,
+labels,
+optimized,
+satisfiesPzi,
+satisfiesPzs,
+state,
+updateTime
+FROM google.aiplatform.feature_online_stores
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new feature_online_stores
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.feature_online_stores (
+locationsId,
+projectsId,
+dedicatedServingEndpoint,
+updateTime,
+etag,
+satisfiesPzs,
+labels,
+createTime,
+optimized,
+name,
+bigtable,
+state,
+encryptionSpec,
+satisfiesPzi
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ dedicatedServingEndpoint }}',
+'{{ updateTime }}',
+'{{ etag }}',
+true|false,
+'{{ labels }}',
+'{{ createTime }}',
+'{{ optimized }}',
+'{{ name }}',
+'{{ bigtable }}',
+'{{ state }}',
+'{{ encryptionSpec }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: dedicatedServingEndpoint
+ value: '{{ dedicatedServingEndpoint }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: optimized
+ value: '{{ optimized }}'
+ - name: name
+ value: '{{ name }}'
+ - name: bigtable
+ value: '{{ bigtable }}'
+ - name: state
+ value: '{{ state }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a feature_online_store only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.feature_online_stores
+SET
+dedicatedServingEndpoint = '{{ dedicatedServingEndpoint }}',
+updateTime = '{{ updateTime }}',
+etag = '{{ etag }}',
+satisfiesPzs = true|false,
+labels = '{{ labels }}',
+createTime = '{{ createTime }}',
+optimized = '{{ optimized }}',
+name = '{{ name }}',
+bigtable = '{{ bigtable }}',
+state = '{{ state }}',
+encryptionSpec = '{{ encryptionSpec }}',
+satisfiesPzi = true|false
+WHERE
+featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified feature_online_store resource.
+
+```sql
+DELETE FROM google.aiplatform.feature_online_stores
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_online_stores_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/feature_online_stores_iam_policies/index.md
new file mode 100644
index 0000000000..f57293d0d6
--- /dev/null
+++ b/docs/google-docs/providers/google/aiplatform/feature_online_stores_iam_policies/index.md
@@ -0,0 +1,59 @@
+
+---
+title: feature_online_stores_iam_policies
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - feature_online_stores_iam_policies
+ - aiplatform
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an feature_online_stores_iam_policy
resource or lists feature_online_stores_iam_policies
in a region
+
+## Overview
+
+Name | feature_online_stores_iam_policies |
+Type | Resource |
+Id | |
+
+
+## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `object` | 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. |
+| | `array` | 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`. |
+| | `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). |
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
+| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
+| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.feature_online_stores_iam_policies
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_view_syncs/index.md b/docs/google-docs/providers/google/aiplatform/feature_view_syncs/index.md
index a3359425dc..ff0d4bbca4 100644
--- a/docs/google-docs/providers/google/aiplatform/feature_view_syncs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/feature_view_syncs/index.md
@@ -1,3 +1,4 @@
+
---
title: feature_view_syncs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- feature_view_syncs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature_view_sync
resource or lists feature_view_syncs
in a region
## Overview
@@ -30,14 +32,36 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Identifier. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` |
+| | `string` | Identifier. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` |
| | `string` | Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet. |
| | `object` | 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). |
| | `object` | 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. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `object` | Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets details of a single FeatureViewSync. |
| | `SELECT` | | Lists FeatureViewSyncs in a given FeatureView. |
-| | `EXEC` | | Lists FeatureViewSyncs in a given FeatureView. |
+
+## `SELECT` examples
+
+Lists FeatureViewSyncs in a given FeatureView.
+
+```sql
+SELECT
+name,
+createTime,
+finalStatus,
+runTime,
+satisfiesPzi,
+satisfiesPzs,
+syncSummary
+FROM google.aiplatform.feature_view_syncs
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND featureViewsId = '{{ featureViewsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_views/index.md b/docs/google-docs/providers/google/aiplatform/feature_views/index.md
index cd4cb904b4..1112029e07 100644
--- a/docs/google-docs/providers/google/aiplatform/feature_views/index.md
+++ b/docs/google-docs/providers/google/aiplatform/feature_views/index.md
@@ -1,3 +1,4 @@
+
---
title: feature_views
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- feature_views
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature_view
resource or lists feature_views
in a region
## Overview
@@ -30,15 +32,19 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` |
+| | `string` | Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` |
| | `object` | |
| | `string` | Output only. Timestamp when this FeatureView was created. |
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | A Feature Registry source for features that need to be synced to Online Store. |
| | `object` | Configuration for vector indexing. |
| | `object` | Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `object` | Configuration for Sync. Only one option is set. |
| | `string` | Output only. Timestamp when this FeatureView was last updated. |
+| | `object` | A Vertex Rag source for features that need to be synced to Online Store. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -47,6 +53,153 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new FeatureView in a given FeatureOnlineStore. |
| | `DELETE` | | Deletes a single FeatureView. |
| | `UPDATE` | | Updates the parameters of a single FeatureView. |
-| | `EXEC` | | Lists FeatureViews in a given FeatureOnlineStore. |
| | `EXEC` | | Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. |
| | `EXEC` | | Triggers on-demand sync for the FeatureView. |
+
+## `SELECT` examples
+
+Lists FeatureViews in a given FeatureOnlineStore.
+
+```sql
+SELECT
+name,
+bigQuerySource,
+createTime,
+etag,
+featureRegistrySource,
+indexConfig,
+labels,
+satisfiesPzi,
+satisfiesPzs,
+syncConfig,
+updateTime,
+vertexRagSource
+FROM google.aiplatform.feature_views
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new feature_views
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.feature_views (
+featureOnlineStoresId,
+locationsId,
+projectsId,
+satisfiesPzs,
+createTime,
+etag,
+satisfiesPzi,
+labels,
+bigQuerySource,
+name,
+updateTime,
+featureRegistrySource,
+indexConfig,
+vertexRagSource,
+syncConfig
+)
+SELECT
+'{{ featureOnlineStoresId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+true|false,
+'{{ createTime }}',
+'{{ etag }}',
+true|false,
+'{{ labels }}',
+'{{ bigQuerySource }}',
+'{{ name }}',
+'{{ updateTime }}',
+'{{ featureRegistrySource }}',
+'{{ indexConfig }}',
+'{{ vertexRagSource }}',
+'{{ syncConfig }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: bigQuerySource
+ value: '{{ bigQuerySource }}'
+ - name: name
+ value: '{{ name }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: featureRegistrySource
+ value: '{{ featureRegistrySource }}'
+ - name: indexConfig
+ value: '{{ indexConfig }}'
+ - name: vertexRagSource
+ value: '{{ vertexRagSource }}'
+ - name: syncConfig
+ value: '{{ syncConfig }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a feature_view only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.feature_views
+SET
+satisfiesPzs = true|false,
+createTime = '{{ createTime }}',
+etag = '{{ etag }}',
+satisfiesPzi = true|false,
+labels = '{{ labels }}',
+bigQuerySource = '{{ bigQuerySource }}',
+name = '{{ name }}',
+updateTime = '{{ updateTime }}',
+featureRegistrySource = '{{ featureRegistrySource }}',
+indexConfig = '{{ indexConfig }}',
+vertexRagSource = '{{ vertexRagSource }}',
+syncConfig = '{{ syncConfig }}'
+WHERE
+featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND featureViewsId = '{{ featureViewsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified feature_view resource.
+
+```sql
+DELETE FROM google.aiplatform.feature_views
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND featureViewsId = '{{ featureViewsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_views_feature_values/index.md b/docs/google-docs/providers/google/aiplatform/feature_views_feature_values/index.md
index 98079d456c..97391043a9 100644
--- a/docs/google-docs/providers/google/aiplatform/feature_views_feature_values/index.md
+++ b/docs/google-docs/providers/google/aiplatform/feature_views_feature_values/index.md
@@ -1,3 +1,4 @@
+
---
title: feature_views_feature_values
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- feature_views_feature_values
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature_views_feature_value
resource or lists feature_views_feature_values
in a region
## Overview
@@ -28,8 +30,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `object` | Lookup key for a feature view. |
+| | `object` | Response structure in the format of key (feature name) and (feature) value pair. |
+| | `object` | Feature values in proto Struct format. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Fetch feature values under a FeatureView. |
+
+## `SELECT` examples
+
+Fetch feature values under a FeatureView.
+
+```sql
+SELECT
+dataKey,
+keyValues,
+protoStruct
+FROM google.aiplatform.feature_views_feature_values
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND featureViewsId = '{{ featureViewsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/feature_views_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/feature_views_iam_policies/index.md
new file mode 100644
index 0000000000..1a77bd9a3a
--- /dev/null
+++ b/docs/google-docs/providers/google/aiplatform/feature_views_iam_policies/index.md
@@ -0,0 +1,60 @@
+
+---
+title: feature_views_iam_policies
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - feature_views_iam_policies
+ - aiplatform
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an feature_views_iam_policy
resource or lists feature_views_iam_policies
in a region
+
+## Overview
+
+Name | feature_views_iam_policies |
+Type | Resource |
+Id | |
+
+
+## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `object` | 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. |
+| | `array` | 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`. |
+| | `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). |
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
+| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
+| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.feature_views_iam_policies
+WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
+AND featureViewsId = '{{ featureViewsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/features/index.md b/docs/google-docs/providers/google/aiplatform/features/index.md
index d412899231..44d071eecf 100644
--- a/docs/google-docs/providers/google/aiplatform/features/index.md
+++ b/docs/google-docs/providers/google/aiplatform/features/index.md
@@ -1,3 +1,4 @@
+
---
title: features
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- features
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an feature
resource or lists features
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. |
+| | `string` | Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. |
| | `string` | Description of the Feature. |
| | `string` | Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created. |
| | `boolean` | Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType. |
@@ -41,13 +43,155 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated. |
| | `string` | Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value. |
| | `string` | Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets details of a single Feature. |
| | `SELECT` | | Lists Features in a given FeatureGroup. |
+| | `INSERT` | | Creates a batch of Features in a given EntityType. |
| | `INSERT` | | Creates a new Feature in a given FeatureGroup. |
| | `DELETE` | | Deletes a single Feature. |
| | `UPDATE` | | Updates the parameters of a single Feature. |
-| | `EXEC` | | Lists Features in a given FeatureGroup. |
-| | `EXEC` | | Creates a batch of Features in a given EntityType. |
+
+## `SELECT` examples
+
+Lists Features in a given FeatureGroup.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+disableMonitoring,
+etag,
+labels,
+monitoringStatsAnomalies,
+pointOfContact,
+updateTime,
+valueType,
+versionColumnName
+FROM google.aiplatform.features
+WHERE featureGroupsId = '{{ featureGroupsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new features
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.features (
+featureGroupsId,
+locationsId,
+projectsId,
+labels,
+createTime,
+versionColumnName,
+valueType,
+disableMonitoring,
+etag,
+description,
+updateTime,
+name,
+monitoringStatsAnomalies,
+pointOfContact
+)
+SELECT
+'{{ featureGroupsId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ labels }}',
+'{{ createTime }}',
+'{{ versionColumnName }}',
+'{{ valueType }}',
+true|false,
+'{{ etag }}',
+'{{ description }}',
+'{{ updateTime }}',
+'{{ name }}',
+'{{ monitoringStatsAnomalies }}',
+'{{ pointOfContact }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: labels
+ value: '{{ labels }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: versionColumnName
+ value: '{{ versionColumnName }}'
+ - name: valueType
+ value: '{{ valueType }}'
+ - name: disableMonitoring
+ value: '{{ disableMonitoring }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: description
+ value: '{{ description }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: name
+ value: '{{ name }}'
+ - name: monitoringStatsAnomalies
+ value: '{{ monitoringStatsAnomalies }}'
+ - name: pointOfContact
+ value: '{{ pointOfContact }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a feature only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.features
+SET
+labels = '{{ labels }}',
+createTime = '{{ createTime }}',
+versionColumnName = '{{ versionColumnName }}',
+valueType = '{{ valueType }}',
+disableMonitoring = true|false,
+etag = '{{ etag }}',
+description = '{{ description }}',
+updateTime = '{{ updateTime }}',
+name = '{{ name }}',
+monitoringStatsAnomalies = '{{ monitoringStatsAnomalies }}',
+pointOfContact = '{{ pointOfContact }}'
+WHERE
+featureGroupsId = '{{ featureGroupsId }}'
+AND featuresId = '{{ featuresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified feature resource.
+
+```sql
+DELETE FROM google.aiplatform.features
+WHERE featureGroupsId = '{{ featureGroupsId }}'
+AND featuresId = '{{ featuresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/featurestores/index.md b/docs/google-docs/providers/google/aiplatform/featurestores/index.md
index 44fb5245a8..ab9f09e2cb 100644
--- a/docs/google-docs/providers/google/aiplatform/featurestores/index.md
+++ b/docs/google-docs/providers/google/aiplatform/featurestores/index.md
@@ -1,3 +1,4 @@
+
---
title: featurestores
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- featurestores
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an featurestore
resource or lists featurestores
in a region
## Overview
@@ -30,15 +32,18 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}` |
+| | `string` | Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}` |
| | `string` | Output only. Timestamp when this Featurestore was created. |
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | Optional. The labels with user-defined metadata to organize your Featurestore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `object` | OnlineServingConfig specifies the details for provisioning online serving resources. |
| | `integer` | Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. State of the featurestore. |
| | `string` | Output only. Timestamp when this Featurestore was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -47,6 +52,142 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Featurestore in a given project and location. |
| | `DELETE` | | Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. |
| | `UPDATE` | | Updates the parameters of a single Featurestore. |
-| | `EXEC` | | Lists Featurestores in a given project and location. |
| | `EXEC` | | Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. |
| | `EXEC` | | Searches Features matching a query in a given project. |
+
+## `SELECT` examples
+
+Lists Featurestores in a given project and location.
+
+```sql
+SELECT
+name,
+createTime,
+encryptionSpec,
+etag,
+labels,
+onlineServingConfig,
+onlineStorageTtlDays,
+satisfiesPzi,
+satisfiesPzs,
+state,
+updateTime
+FROM google.aiplatform.featurestores
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new featurestores
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.featurestores (
+locationsId,
+projectsId,
+onlineStorageTtlDays,
+encryptionSpec,
+name,
+state,
+createTime,
+labels,
+etag,
+onlineServingConfig,
+satisfiesPzs,
+updateTime,
+satisfiesPzi
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ onlineStorageTtlDays }}',
+'{{ encryptionSpec }}',
+'{{ name }}',
+'{{ state }}',
+'{{ createTime }}',
+'{{ labels }}',
+'{{ etag }}',
+'{{ onlineServingConfig }}',
+true|false,
+'{{ updateTime }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: onlineStorageTtlDays
+ value: '{{ onlineStorageTtlDays }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: name
+ value: '{{ name }}'
+ - name: state
+ value: '{{ state }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: onlineServingConfig
+ value: '{{ onlineServingConfig }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a featurestore only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.featurestores
+SET
+onlineStorageTtlDays = '{{ onlineStorageTtlDays }}',
+encryptionSpec = '{{ encryptionSpec }}',
+name = '{{ name }}',
+state = '{{ state }}',
+createTime = '{{ createTime }}',
+labels = '{{ labels }}',
+etag = '{{ etag }}',
+onlineServingConfig = '{{ onlineServingConfig }}',
+satisfiesPzs = true|false,
+updateTime = '{{ updateTime }}',
+satisfiesPzi = true|false
+WHERE
+featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified featurestore resource.
+
+```sql
+DELETE FROM google.aiplatform.featurestores
+WHERE featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md
index 7b8729fb3e..cfd00c58dd 100644
--- a/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md
+++ b/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: featurestores_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- featurestores_iam_policies
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an featurestores_iam_policy
resource or lists featurestores_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.featurestores_iam_policies
+WHERE featurestoresId = '{{ featurestoresId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md
index 77cdf98d69..81e6d8d891 100644
--- a/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: hyperparameter_tuning_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- hyperparameter_tuning_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an hyperparameter_tuning_job
resource or lists hyperparameter_tuning_jobs
in a region
## Overview
@@ -40,12 +42,15 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `integer` | The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails. |
| | `integer` | Required. The desired total number of Trials. |
| | `integer` | Required. The desired number of Trials to run in parallel. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. |
| | `string` | Output only. The detailed state of the job. |
| | `object` | Represents specification of a Study. |
| | `object` | Represents the spec of a CustomJob. |
| | `array` | Output only. Trials of the HyperparameterTuningJob. |
| | `string` | Output only. Time when the HyperparameterTuningJob was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -53,5 +58,152 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists HyperparameterTuningJobs in a Location. |
| | `INSERT` | | Creates a HyperparameterTuningJob |
| | `DELETE` | | Deletes a HyperparameterTuningJob. |
-| | `EXEC` | | Lists HyperparameterTuningJobs in a Location. |
| | `EXEC` | | Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists HyperparameterTuningJobs in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+encryptionSpec,
+endTime,
+error,
+labels,
+maxFailedTrialCount,
+maxTrialCount,
+parallelTrialCount,
+satisfiesPzi,
+satisfiesPzs,
+startTime,
+state,
+studySpec,
+trialJobSpec,
+trials,
+updateTime
+FROM google.aiplatform.hyperparameter_tuning_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new hyperparameter_tuning_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.hyperparameter_tuning_jobs (
+locationsId,
+projectsId,
+name,
+trialJobSpec,
+error,
+studySpec,
+updateTime,
+createTime,
+trials,
+maxTrialCount,
+labels,
+satisfiesPzs,
+state,
+maxFailedTrialCount,
+endTime,
+satisfiesPzi,
+displayName,
+encryptionSpec,
+startTime,
+parallelTrialCount
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ trialJobSpec }}',
+'{{ error }}',
+'{{ studySpec }}',
+'{{ updateTime }}',
+'{{ createTime }}',
+'{{ trials }}',
+'{{ maxTrialCount }}',
+'{{ labels }}',
+true|false,
+'{{ state }}',
+'{{ maxFailedTrialCount }}',
+'{{ endTime }}',
+true|false,
+'{{ displayName }}',
+'{{ encryptionSpec }}',
+'{{ startTime }}',
+'{{ parallelTrialCount }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: trialJobSpec
+ value: '{{ trialJobSpec }}'
+ - name: error
+ value: '{{ error }}'
+ - name: studySpec
+ value: '{{ studySpec }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: trials
+ value: '{{ trials }}'
+ - name: maxTrialCount
+ value: '{{ maxTrialCount }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: state
+ value: '{{ state }}'
+ - name: maxFailedTrialCount
+ value: '{{ maxFailedTrialCount }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: parallelTrialCount
+ value: '{{ parallelTrialCount }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified hyperparameter_tuning_job resource.
+
+```sql
+DELETE FROM google.aiplatform.hyperparameter_tuning_jobs
+WHERE hyperparameterTuningJobsId = '{{ hyperparameterTuningJobsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/index.md b/docs/google-docs/providers/google/aiplatform/index.md
index 6bb765c4e5..2e40a68d6b 100644
--- a/docs/google-docs/providers/google/aiplatform/index.md
+++ b/docs/google-docs/providers/google/aiplatform/index.md
@@ -9,34 +9,23 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-Train high-quality custom machine learning models with minimal machine learning expertise and effort.
-
+The aiplatform service documentation.
+
:::info Service Summary
-total resources: 65
-total selectable resources: 54
-total methods: 361
+total resources: 68
:::
-## Overview
-
-Name | google.aiplatform |
-Type | Service |
-Title | Vertex AI API |
-Description | Train high-quality custom machine learning models with minimal machine learning expertise and effort. |
-Id | aiplatform:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md
index 8a82c1db3f..7c5e954d8b 100644
--- a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md
+++ b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md
@@ -1,3 +1,4 @@
+
---
title: index_endpoints
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- index_endpoints
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an index_endpoint
resource or lists index_endpoints
in a region
## Overview
@@ -39,11 +41,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
-| | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [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. |
+| | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [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. |
| | `object` | Represents configuration for private service connect. |
| | `string` | Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. |
| | `boolean` | Optional. If true, the deployed index will be accessible through public endpoint. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -52,9 +57,175 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an IndexEndpoint. |
| | `DELETE` | | Deletes an IndexEndpoint. |
| | `UPDATE` | | Updates an IndexEndpoint. |
-| | `EXEC` | | Lists IndexEndpoints in a Location. |
| | `EXEC` | | Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. |
| | `EXEC` | | Finds the nearest neighbors of each vector within the request. |
| | `EXEC` | | Update an existing DeployedIndex under an IndexEndpoint. |
| | `EXEC` | | Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. |
| | `EXEC` | | Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. |
+
+## `SELECT` examples
+
+Lists IndexEndpoints in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+deployedIndexes,
+displayName,
+enablePrivateServiceConnect,
+encryptionSpec,
+etag,
+labels,
+network,
+privateServiceConnectConfig,
+publicEndpointDomainName,
+publicEndpointEnabled,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.index_endpoints
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new index_endpoints
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.index_endpoints (
+locationsId,
+projectsId,
+encryptionSpec,
+network,
+displayName,
+publicEndpointDomainName,
+deployedIndexes,
+publicEndpointEnabled,
+name,
+enablePrivateServiceConnect,
+satisfiesPzs,
+etag,
+labels,
+satisfiesPzi,
+privateServiceConnectConfig,
+createTime,
+description,
+updateTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ encryptionSpec }}',
+'{{ network }}',
+'{{ displayName }}',
+'{{ publicEndpointDomainName }}',
+'{{ deployedIndexes }}',
+true|false,
+'{{ name }}',
+true|false,
+true|false,
+'{{ etag }}',
+'{{ labels }}',
+true|false,
+'{{ privateServiceConnectConfig }}',
+'{{ createTime }}',
+'{{ description }}',
+'{{ updateTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: network
+ value: '{{ network }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: publicEndpointDomainName
+ value: '{{ publicEndpointDomainName }}'
+ - name: deployedIndexes
+ value: '{{ deployedIndexes }}'
+ - name: publicEndpointEnabled
+ value: '{{ publicEndpointEnabled }}'
+ - name: name
+ value: '{{ name }}'
+ - name: enablePrivateServiceConnect
+ value: '{{ enablePrivateServiceConnect }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: privateServiceConnectConfig
+ value: '{{ privateServiceConnectConfig }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: description
+ value: '{{ description }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a index_endpoint only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.index_endpoints
+SET
+encryptionSpec = '{{ encryptionSpec }}',
+network = '{{ network }}',
+displayName = '{{ displayName }}',
+publicEndpointDomainName = '{{ publicEndpointDomainName }}',
+deployedIndexes = '{{ deployedIndexes }}',
+publicEndpointEnabled = true|false,
+name = '{{ name }}',
+enablePrivateServiceConnect = true|false,
+satisfiesPzs = true|false,
+etag = '{{ etag }}',
+labels = '{{ labels }}',
+satisfiesPzi = true|false,
+privateServiceConnectConfig = '{{ privateServiceConnectConfig }}',
+createTime = '{{ createTime }}',
+description = '{{ description }}',
+updateTime = '{{ updateTime }}'
+WHERE
+indexEndpointsId = '{{ indexEndpointsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified index_endpoint resource.
+
+```sql
+DELETE FROM google.aiplatform.index_endpoints
+WHERE indexEndpointsId = '{{ indexEndpointsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/indexes/index.md b/docs/google-docs/providers/google/aiplatform/indexes/index.md
index a12ca45f3f..c1d390cdb3 100644
--- a/docs/google-docs/providers/google/aiplatform/indexes/index.md
+++ b/docs/google-docs/providers/google/aiplatform/indexes/index.md
@@ -1,3 +1,4 @@
+
---
title: indexes
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- indexes
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an index
resource or lists indexes
in a region
## Overview
@@ -42,7 +44,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `any` | An additional information about the Index; the schema of the metadata can be found in metadata_schema. |
| | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -51,5 +56,165 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an Index. |
| | `DELETE` | | Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. |
| | `UPDATE` | | Updates an Index. |
-| | `EXEC` | | Lists Indexes in a Location. |
| | `EXEC` | | Add/update Datapoints into an Index. |
+
+## `SELECT` examples
+
+Lists Indexes in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+deployedIndexes,
+displayName,
+encryptionSpec,
+etag,
+indexStats,
+indexUpdateMethod,
+labels,
+metadata,
+metadataSchemaUri,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.indexes
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new indexes
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.indexes (
+locationsId,
+projectsId,
+indexStats,
+satisfiesPzi,
+satisfiesPzs,
+name,
+indexUpdateMethod,
+encryptionSpec,
+createTime,
+metadata,
+metadataSchemaUri,
+description,
+deployedIndexes,
+displayName,
+updateTime,
+labels,
+etag
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ indexStats }}',
+true|false,
+true|false,
+'{{ name }}',
+'{{ indexUpdateMethod }}',
+'{{ encryptionSpec }}',
+'{{ createTime }}',
+'{{ metadata }}',
+'{{ metadataSchemaUri }}',
+'{{ description }}',
+'{{ deployedIndexes }}',
+'{{ displayName }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ etag }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: indexStats
+ value: '{{ indexStats }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: name
+ value: '{{ name }}'
+ - name: indexUpdateMethod
+ value: '{{ indexUpdateMethod }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: metadataSchemaUri
+ value: '{{ metadataSchemaUri }}'
+ - name: description
+ value: '{{ description }}'
+ - name: deployedIndexes
+ value: '{{ deployedIndexes }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: etag
+ value: '{{ etag }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a index only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.indexes
+SET
+indexStats = '{{ indexStats }}',
+satisfiesPzi = true|false,
+satisfiesPzs = true|false,
+name = '{{ name }}',
+indexUpdateMethod = '{{ indexUpdateMethod }}',
+encryptionSpec = '{{ encryptionSpec }}',
+createTime = '{{ createTime }}',
+metadata = '{{ metadata }}',
+metadataSchemaUri = '{{ metadataSchemaUri }}',
+description = '{{ description }}',
+deployedIndexes = '{{ deployedIndexes }}',
+displayName = '{{ displayName }}',
+updateTime = '{{ updateTime }}',
+labels = '{{ labels }}',
+etag = '{{ etag }}'
+WHERE
+indexesId = '{{ indexesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified index resource.
+
+```sql
+DELETE FROM google.aiplatform.indexes
+WHERE indexesId = '{{ indexesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md b/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md
index 708a80824d..bec7ca6b76 100644
--- a/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md
+++ b/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md
@@ -1,3 +1,4 @@
+
---
title: indexes_datapoints
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- indexes_datapoints
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an indexes_datapoint
resource or lists indexes_datapoints
in a region
## Overview
@@ -28,8 +30,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `DELETE` | | Remove Datapoints from an Index. |
+
+## `DELETE` example
+
+Deletes the specified indexes_datapoint resource.
+
+```sql
+DELETE FROM google.aiplatform.indexes_datapoints
+WHERE indexesId = '{{ indexesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/locations/index.md b/docs/google-docs/providers/google/aiplatform/locations/index.md
index 9c8403ffda..86031df6a9 100644
--- a/docs/google-docs/providers/google/aiplatform/locations/index.md
+++ b/docs/google-docs/providers/google/aiplatform/locations/index.md
@@ -1,3 +1,4 @@
+
---
title: locations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- locations
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an location
resource or lists locations
in a region
## Overview
@@ -32,12 +34,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
-| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
+| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| | `string` | The canonical id for this location. For example: `"us-east1"`. |
| | `object` | Service-specific metadata. For example the available capacity at the given location. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets information about a location. |
| | `SELECT` | | Lists information about the supported locations for this service. |
-| | `EXEC` | | Lists information about the supported locations for this service. |
+| | `EXEC` | | Evaluates instances based on a given metric. |
+
+## `SELECT` examples
+
+Lists information about the supported locations for this service.
+
+```sql
+SELECT
+name,
+displayName,
+labels,
+locationId,
+metadata
+FROM google.aiplatform.locations
+WHERE projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md
index 0c0e3cd8b9..023db1210b 100644
--- a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md
+++ b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md
@@ -1,3 +1,4 @@
+
---
title: metadata_schemas
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- metadata_schemas
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an metadata_schema
resource or lists metadata_schemas
in a region
## Overview
@@ -36,10 +38,90 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) |
| | `string` | The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema. |
| | `string` | The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Retrieves a specific MetadataSchema. |
| | `SELECT` | | Lists MetadataSchemas. |
| | `INSERT` | | Creates a MetadataSchema. |
-| | `EXEC` | | Lists MetadataSchemas. |
+
+## `SELECT` examples
+
+Lists MetadataSchemas.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+schema,
+schemaType,
+schemaVersion
+FROM google.aiplatform.metadata_schemas
+WHERE locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new metadata_schemas
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.metadata_schemas (
+locationsId,
+metadataStoresId,
+projectsId,
+schemaType,
+schema,
+description,
+schemaVersion,
+name,
+createTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ metadataStoresId }}',
+'{{ projectsId }}',
+'{{ schemaType }}',
+'{{ schema }}',
+'{{ description }}',
+'{{ schemaVersion }}',
+'{{ name }}',
+'{{ createTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: schemaType
+ value: '{{ schemaType }}'
+ - name: schema
+ value: '{{ schema }}'
+ - name: description
+ value: '{{ description }}'
+ - name: schemaVersion
+ value: '{{ schemaVersion }}'
+ - name: name
+ value: '{{ name }}'
+ - name: createTime
+ value: '{{ createTime }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md
index 08e318f3c8..f21068a94c 100644
--- a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md
+++ b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md
@@ -1,3 +1,4 @@
+
---
title: metadata_stores
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- metadata_stores
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an metadata_store
resource or lists metadata_stores
in a region
## Overview
@@ -37,6 +39,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `object` | Represents state information for a MetadataStore. |
| | `string` | Output only. Timestamp when this MetadataStore was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -44,4 +47,96 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists MetadataStores for a Location. |
| | `INSERT` | | Initializes a MetadataStore, including allocation of resources. |
| | `DELETE` | | Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). |
-| | `EXEC` | | Lists MetadataStores for a Location. |
+
+## `SELECT` examples
+
+Lists MetadataStores for a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+dataplexConfig,
+encryptionSpec,
+state,
+updateTime
+FROM google.aiplatform.metadata_stores
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new metadata_stores
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.metadata_stores (
+locationsId,
+projectsId,
+dataplexConfig,
+state,
+name,
+createTime,
+description,
+encryptionSpec,
+updateTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ dataplexConfig }}',
+'{{ state }}',
+'{{ name }}',
+'{{ createTime }}',
+'{{ description }}',
+'{{ encryptionSpec }}',
+'{{ updateTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: dataplexConfig
+ value: '{{ dataplexConfig }}'
+ - name: state
+ value: '{{ state }}'
+ - name: name
+ value: '{{ name }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: description
+ value: '{{ description }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified metadata_store resource.
+
+```sql
+DELETE FROM google.aiplatform.metadata_stores
+WHERE locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md b/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md
index af2ccb292e..320c566fdc 100644
--- a/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md
+++ b/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md
@@ -1,3 +1,4 @@
+
---
title: migratable_resources
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- migratable_resources
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an migratable_resource
resource or lists migratable_resources
in a region
## Overview
@@ -28,7 +30,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
diff --git a/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md b/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md
index 524398c8e2..12ad0540f1 100644
--- a/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: model_deployment_monitoring_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- model_deployment_monitoring_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an model_deployment_monitoring_job
resource or lists model_deployment_monitoring_jobs
in a region
## Overview
@@ -37,11 +39,11 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. |
| | `boolean` | If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging#pricing). |
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
-| | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` |
+| | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` |
| | `object` | 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). |
| | `object` | The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `object` | All metadata of most recent monitoring pipelines. |
-| | `string` | The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. { second: 3600} indicates ttl = 1 day. |
+| | `string` | The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. { second: 3600} indicates ttl = 1 day. |
| | `object` | Sampling Strategy for logging, can be for both training and prediction dataset. |
| | `array` | Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. |
| | `object` | The config for scheduling monitoring job. |
@@ -49,10 +51,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. |
| | `string` | YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. |
| | `any` | Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Schedule state when the monitoring job is in Running state. |
| | `string` | Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. |
| | `object` | The Google Cloud Storage location where the output is to be written to. |
| | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -61,7 +66,227 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. |
| | `DELETE` | | Deletes a ModelDeploymentMonitoringJob. |
| | `UPDATE` | | Updates a ModelDeploymentMonitoringJob. |
-| | `EXEC` | | Lists ModelDeploymentMonitoringJobs in a Location. |
| | `EXEC` | | Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. |
| | `EXEC` | | Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. |
| | `EXEC` | | Searches Model Monitoring Statistics generated within a given time window. |
+
+## `SELECT` examples
+
+Lists ModelDeploymentMonitoringJobs in a Location.
+
+```sql
+SELECT
+name,
+analysisInstanceSchemaUri,
+bigqueryTables,
+createTime,
+displayName,
+enableMonitoringPipelineLogs,
+encryptionSpec,
+endpoint,
+error,
+labels,
+latestMonitoringPipelineMetadata,
+logTtl,
+loggingSamplingStrategy,
+modelDeploymentMonitoringObjectiveConfigs,
+modelDeploymentMonitoringScheduleConfig,
+modelMonitoringAlertConfig,
+nextScheduleTime,
+predictInstanceSchemaUri,
+samplePredictInstance,
+satisfiesPzi,
+satisfiesPzs,
+scheduleState,
+state,
+statsAnomaliesBaseDirectory,
+updateTime
+FROM google.aiplatform.model_deployment_monitoring_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new model_deployment_monitoring_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.model_deployment_monitoring_jobs (
+locationsId,
+projectsId,
+displayName,
+samplePredictInstance,
+bigqueryTables,
+nextScheduleTime,
+satisfiesPzi,
+scheduleState,
+predictInstanceSchemaUri,
+logTtl,
+satisfiesPzs,
+state,
+statsAnomaliesBaseDirectory,
+modelDeploymentMonitoringScheduleConfig,
+endpoint,
+modelMonitoringAlertConfig,
+latestMonitoringPipelineMetadata,
+encryptionSpec,
+labels,
+analysisInstanceSchemaUri,
+loggingSamplingStrategy,
+name,
+enableMonitoringPipelineLogs,
+updateTime,
+error,
+createTime,
+modelDeploymentMonitoringObjectiveConfigs
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ displayName }}',
+'{{ samplePredictInstance }}',
+'{{ bigqueryTables }}',
+'{{ nextScheduleTime }}',
+true|false,
+'{{ scheduleState }}',
+'{{ predictInstanceSchemaUri }}',
+'{{ logTtl }}',
+true|false,
+'{{ state }}',
+'{{ statsAnomaliesBaseDirectory }}',
+'{{ modelDeploymentMonitoringScheduleConfig }}',
+'{{ endpoint }}',
+'{{ modelMonitoringAlertConfig }}',
+'{{ latestMonitoringPipelineMetadata }}',
+'{{ encryptionSpec }}',
+'{{ labels }}',
+'{{ analysisInstanceSchemaUri }}',
+'{{ loggingSamplingStrategy }}',
+'{{ name }}',
+true|false,
+'{{ updateTime }}',
+'{{ error }}',
+'{{ createTime }}',
+'{{ modelDeploymentMonitoringObjectiveConfigs }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: samplePredictInstance
+ value: '{{ samplePredictInstance }}'
+ - name: bigqueryTables
+ value: '{{ bigqueryTables }}'
+ - name: nextScheduleTime
+ value: '{{ nextScheduleTime }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: scheduleState
+ value: '{{ scheduleState }}'
+ - name: predictInstanceSchemaUri
+ value: '{{ predictInstanceSchemaUri }}'
+ - name: logTtl
+ value: '{{ logTtl }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: state
+ value: '{{ state }}'
+ - name: statsAnomaliesBaseDirectory
+ value: '{{ statsAnomaliesBaseDirectory }}'
+ - name: modelDeploymentMonitoringScheduleConfig
+ value: '{{ modelDeploymentMonitoringScheduleConfig }}'
+ - name: endpoint
+ value: '{{ endpoint }}'
+ - name: modelMonitoringAlertConfig
+ value: '{{ modelMonitoringAlertConfig }}'
+ - name: latestMonitoringPipelineMetadata
+ value: '{{ latestMonitoringPipelineMetadata }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: analysisInstanceSchemaUri
+ value: '{{ analysisInstanceSchemaUri }}'
+ - name: loggingSamplingStrategy
+ value: '{{ loggingSamplingStrategy }}'
+ - name: name
+ value: '{{ name }}'
+ - name: enableMonitoringPipelineLogs
+ value: '{{ enableMonitoringPipelineLogs }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: error
+ value: '{{ error }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: modelDeploymentMonitoringObjectiveConfigs
+ value: '{{ modelDeploymentMonitoringObjectiveConfigs }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a model_deployment_monitoring_job only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.model_deployment_monitoring_jobs
+SET
+displayName = '{{ displayName }}',
+samplePredictInstance = '{{ samplePredictInstance }}',
+bigqueryTables = '{{ bigqueryTables }}',
+nextScheduleTime = '{{ nextScheduleTime }}',
+satisfiesPzi = true|false,
+scheduleState = '{{ scheduleState }}',
+predictInstanceSchemaUri = '{{ predictInstanceSchemaUri }}',
+logTtl = '{{ logTtl }}',
+satisfiesPzs = true|false,
+state = '{{ state }}',
+statsAnomaliesBaseDirectory = '{{ statsAnomaliesBaseDirectory }}',
+modelDeploymentMonitoringScheduleConfig = '{{ modelDeploymentMonitoringScheduleConfig }}',
+endpoint = '{{ endpoint }}',
+modelMonitoringAlertConfig = '{{ modelMonitoringAlertConfig }}',
+latestMonitoringPipelineMetadata = '{{ latestMonitoringPipelineMetadata }}',
+encryptionSpec = '{{ encryptionSpec }}',
+labels = '{{ labels }}',
+analysisInstanceSchemaUri = '{{ analysisInstanceSchemaUri }}',
+loggingSamplingStrategy = '{{ loggingSamplingStrategy }}',
+name = '{{ name }}',
+enableMonitoringPipelineLogs = true|false,
+updateTime = '{{ updateTime }}',
+error = '{{ error }}',
+createTime = '{{ createTime }}',
+modelDeploymentMonitoringObjectiveConfigs = '{{ modelDeploymentMonitoringObjectiveConfigs }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND modelDeploymentMonitoringJobsId = '{{ modelDeploymentMonitoringJobsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified model_deployment_monitoring_job resource.
+
+```sql
+DELETE FROM google.aiplatform.model_deployment_monitoring_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND modelDeploymentMonitoringJobsId = '{{ modelDeploymentMonitoringJobsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/models/index.md b/docs/google-docs/providers/google/aiplatform/models/index.md
index c14f323233..052758bab7 100644
--- a/docs/google-docs/providers/google/aiplatform/models/index.md
+++ b/docs/google-docs/providers/google/aiplatform/models/index.md
@@ -1,3 +1,4 @@
+
---
title: models
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- models
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an model
resource or lists models
in a region
## Overview
@@ -44,23 +46,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Specification of Model explanation. |
| | `object` | The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `any` | Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information. |
-| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
+| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
| | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. |
| | `object` | Detail description of the source information of the model. |
| | `object` | Contains information about the original Model if this Model is a copy. |
| | `string` | Optional. This field is populated if the model is produced by a pipeline job. |
| | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `array` | Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. |
| | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. |
| | `array` | Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. |
| | `array` | Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. |
| | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. |
| | `string` | Output only. Timestamp when this Model was most recently updated. |
-| | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. |
+| | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. |
| | `string` | Output only. Timestamp when this version was created. |
| | `string` | The description of this version. |
| | `string` | Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation. |
| | `string` | Output only. Timestamp when this version was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -68,7 +73,6 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists Models in a Location. |
| | `DELETE` | | Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. |
| | `UPDATE` | | Updates a Model. |
-| | `EXEC` | | Lists Models in a Location. |
| | `EXEC` | | Return a list of tokens based on the input text. |
| | `EXEC` | | Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. |
| | `EXEC` | | Perform a token counting. |
@@ -81,3 +85,104 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `EXEC` | | Generate content with multimodal inputs with streaming support. |
| | `EXEC` | | Perform a streaming online prediction with an arbitrary HTTP payload. |
| | `EXEC` | | Uploads a Model artifact into Vertex AI. |
+
+## `SELECT` examples
+
+Lists Models in a Location.
+
+```sql
+SELECT
+name,
+description,
+artifactUri,
+baseModelSource,
+containerSpec,
+createTime,
+dataStats,
+deployedModels,
+displayName,
+encryptionSpec,
+etag,
+explanationSpec,
+labels,
+metadata,
+metadataArtifact,
+metadataSchemaUri,
+modelSourceInfo,
+originalModelInfo,
+pipelineJob,
+predictSchemata,
+satisfiesPzi,
+satisfiesPzs,
+supportedDeploymentResourcesTypes,
+supportedExportFormats,
+supportedInputStorageFormats,
+supportedOutputStorageFormats,
+trainingPipeline,
+updateTime,
+versionAliases,
+versionCreateTime,
+versionDescription,
+versionId,
+versionUpdateTime
+FROM google.aiplatform.models
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `UPDATE` example
+
+Updates a model only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.models
+SET
+dataStats = '{{ dataStats }}',
+supportedDeploymentResourcesTypes = '{{ supportedDeploymentResourcesTypes }}',
+versionId = '{{ versionId }}',
+createTime = '{{ createTime }}',
+satisfiesPzi = true|false,
+containerSpec = '{{ containerSpec }}',
+versionAliases = '{{ versionAliases }}',
+deployedModels = '{{ deployedModels }}',
+baseModelSource = '{{ baseModelSource }}',
+versionCreateTime = '{{ versionCreateTime }}',
+etag = '{{ etag }}',
+predictSchemata = '{{ predictSchemata }}',
+modelSourceInfo = '{{ modelSourceInfo }}',
+supportedOutputStorageFormats = '{{ supportedOutputStorageFormats }}',
+metadata = '{{ metadata }}',
+metadataSchemaUri = '{{ metadataSchemaUri }}',
+supportedExportFormats = '{{ supportedExportFormats }}',
+artifactUri = '{{ artifactUri }}',
+supportedInputStorageFormats = '{{ supportedInputStorageFormats }}',
+explanationSpec = '{{ explanationSpec }}',
+satisfiesPzs = true|false,
+versionUpdateTime = '{{ versionUpdateTime }}',
+updateTime = '{{ updateTime }}',
+description = '{{ description }}',
+trainingPipeline = '{{ trainingPipeline }}',
+labels = '{{ labels }}',
+versionDescription = '{{ versionDescription }}',
+metadataArtifact = '{{ metadataArtifact }}',
+pipelineJob = '{{ pipelineJob }}',
+displayName = '{{ displayName }}',
+encryptionSpec = '{{ encryptionSpec }}',
+name = '{{ name }}',
+originalModelInfo = '{{ originalModelInfo }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified model resource.
+
+```sql
+DELETE FROM google.aiplatform.models
+WHERE locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md b/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md
index 9301f4a006..8131350429 100644
--- a/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md
+++ b/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md
@@ -1,3 +1,4 @@
+
---
title: models_explanation_dataset
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- models_explanation_dataset
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an models_explanation_dataset
resource or lists models_explanation_dataset
in a region
## Overview
@@ -28,8 +30,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Incrementally update the dataset used for an examples model. |
+
+## `UPDATE` example
+
+Updates a models_explanation_dataset only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.models_explanation_dataset
+SET
+examples = '{{ examples }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/models_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/models_iam_policies/index.md
index 0f0bcbaf4c..fcff390938 100644
--- a/docs/google-docs/providers/google/aiplatform/models_iam_policies/index.md
+++ b/docs/google-docs/providers/google/aiplatform/models_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: models_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- models_iam_policies
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an models_iam_policy
resource or lists models_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.models_iam_policies
+WHERE locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/models_version/index.md b/docs/google-docs/providers/google/aiplatform/models_version/index.md
index 93b00e8724..7ee340481b 100644
--- a/docs/google-docs/providers/google/aiplatform/models_version/index.md
+++ b/docs/google-docs/providers/google/aiplatform/models_version/index.md
@@ -1,3 +1,4 @@
+
---
title: models_version
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- models_version
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an models_version
resource or lists models_version
in a region
## Overview
@@ -28,8 +30,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `DELETE` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `DELETE` | | Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. |
+
+## `DELETE` example
+
+Deletes the specified models_version resource.
+
+```sql
+DELETE FROM google.aiplatform.models_version
+WHERE locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/models_versions/index.md b/docs/google-docs/providers/google/aiplatform/models_versions/index.md
index 7b12b4517f..e518e562f8 100644
--- a/docs/google-docs/providers/google/aiplatform/models_versions/index.md
+++ b/docs/google-docs/providers/google/aiplatform/models_versions/index.md
@@ -1,3 +1,4 @@
+
---
title: models_versions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- models_versions
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an models_version
resource or lists models_versions
in a region
## Overview
@@ -44,25 +46,72 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Specification of Model explanation. |
| | `object` | The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `any` | Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information. |
-| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
+| | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. |
| | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. |
| | `object` | Detail description of the source information of the model. |
| | `object` | Contains information about the original Model if this Model is a copy. |
| | `string` | Optional. This field is populated if the model is produced by a pipeline job. |
| | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `array` | Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. |
| | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. |
| | `array` | Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. |
| | `array` | Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. |
| | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. |
| | `string` | Output only. Timestamp when this Model was most recently updated. |
-| | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. |
+| | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. |
| | `string` | Output only. Timestamp when this version was created. |
| | `string` | The description of this version. |
| | `string` | Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation. |
| | `string` | Output only. Timestamp when this version was most recently updated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists versions of the specified model. |
+
+## `SELECT` examples
+
+Lists versions of the specified model.
+
+```sql
+SELECT
+name,
+description,
+artifactUri,
+baseModelSource,
+containerSpec,
+createTime,
+dataStats,
+deployedModels,
+displayName,
+encryptionSpec,
+etag,
+explanationSpec,
+labels,
+metadata,
+metadataArtifact,
+metadataSchemaUri,
+modelSourceInfo,
+originalModelInfo,
+pipelineJob,
+predictSchemata,
+satisfiesPzi,
+satisfiesPzs,
+supportedDeploymentResourcesTypes,
+supportedExportFormats,
+supportedInputStorageFormats,
+supportedOutputStorageFormats,
+trainingPipeline,
+updateTime,
+versionAliases,
+versionCreateTime,
+versionDescription,
+versionId,
+versionUpdateTime
+FROM google.aiplatform.models_versions
+WHERE locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md
index eef1643700..0c88e86c05 100644
--- a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: nas_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- nas_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an nas_job
resource or lists nas_jobs
in a region
## Overview
@@ -40,9 +42,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
| | `object` | Represents a uCAIP NasJob output. |
| | `object` | Represents the spec of a NasJob. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. |
| | `string` | Output only. The detailed state of the job. |
| | `string` | Output only. Time when the NasJob was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -50,5 +55,137 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists NasJobs in a Location. |
| | `INSERT` | | Creates a NasJob |
| | `DELETE` | | Deletes a NasJob. |
-| | `EXEC` | | Lists NasJobs in a Location. |
| | `EXEC` | | Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists NasJobs in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+enableRestrictedImageTraining,
+encryptionSpec,
+endTime,
+error,
+labels,
+nasJobOutput,
+nasJobSpec,
+satisfiesPzi,
+satisfiesPzs,
+startTime,
+state,
+updateTime
+FROM google.aiplatform.nas_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new nas_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.nas_jobs (
+locationsId,
+projectsId,
+createTime,
+encryptionSpec,
+startTime,
+error,
+satisfiesPzi,
+nasJobSpec,
+satisfiesPzs,
+nasJobOutput,
+displayName,
+endTime,
+updateTime,
+enableRestrictedImageTraining,
+labels,
+name,
+state
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ createTime }}',
+'{{ encryptionSpec }}',
+'{{ startTime }}',
+'{{ error }}',
+true|false,
+'{{ nasJobSpec }}',
+true|false,
+'{{ nasJobOutput }}',
+'{{ displayName }}',
+'{{ endTime }}',
+'{{ updateTime }}',
+true|false,
+'{{ labels }}',
+'{{ name }}',
+'{{ state }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: error
+ value: '{{ error }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: nasJobSpec
+ value: '{{ nasJobSpec }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: nasJobOutput
+ value: '{{ nasJobOutput }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: enableRestrictedImageTraining
+ value: '{{ enableRestrictedImageTraining }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: name
+ value: '{{ name }}'
+ - name: state
+ value: '{{ state }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified nas_job resource.
+
+```sql
+DELETE FROM google.aiplatform.nas_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND nasJobsId = '{{ nasJobsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md b/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md
index c6a368d838..98c7d71eab 100644
--- a/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md
+++ b/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md
@@ -1,3 +1,4 @@
+
---
title: nas_trial_details
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- nas_trial_details
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an nas_trial_detail
resource or lists nas_trial_details
in a region
## Overview
@@ -34,9 +36,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The parameters for the NasJob NasTrial. |
| | `object` | Represents a uCAIP NasJob trial. |
| | `object` | Represents a uCAIP NasJob trial. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a NasTrialDetail. |
| | `SELECT` | | List top NasTrialDetails of a NasJob. |
-| | `EXEC` | | List top NasTrialDetails of a NasJob. |
+
+## `SELECT` examples
+
+List top NasTrialDetails of a NasJob.
+
+```sql
+SELECT
+name,
+parameters,
+searchTrial,
+trainTrial
+FROM google.aiplatform.nas_trial_details
+WHERE locationsId = '{{ locationsId }}'
+AND nasJobsId = '{{ nasJobsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md b/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md
new file mode 100644
index 0000000000..45858fb654
--- /dev/null
+++ b/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md
@@ -0,0 +1,202 @@
+
+---
+title: notebook_execution_jobs
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - notebook_execution_jobs
+ - aiplatform
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an notebook_execution_job
resource or lists notebook_execution_jobs
in a region
+
+## Overview
+
+Name | notebook_execution_jobs |
+Type | Resource |
+Id | |
+
+
+## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `string` | Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}` |
+| | `string` | Output only. Timestamp when this NotebookExecutionJob was created. |
+| | `object` | The Dataform Repository containing the input notebook. |
+| | `object` | The content of the input notebook in ipynb format. |
+| | `string` | The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
+| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
+| | `string` | Max running time of the execution job in seconds (default 86400s / 24 hrs). |
+| | `string` | The user email to run the execution as. Only supported by Colab runtimes. |
+| | `object` | The Cloud Storage uri for the input notebook. |
+| | `string` | The Cloud Storage location to upload the result to. Format: `gs://bucket-name` |
+| | `string` | Output only. The state of the NotebookExecutionJob. |
+| | `object` | The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
+| | `string` | The NotebookRuntimeTemplate to source compute configuration from. |
+| | `string` | Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` |
+| | `string` | The service account to run the execution as. |
+| | `object` | 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). |
+| | `string` | Output only. Timestamp when this NotebookExecutionJob was most recently updated. |
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets a NotebookExecutionJob. |
+| | `SELECT` | | Lists NotebookExecutionJobs in a Location. |
+| | `INSERT` | | Creates a NotebookExecutionJob. |
+| | `DELETE` | | Deletes a NotebookExecutionJob. |
+
+## `SELECT` examples
+
+Lists NotebookExecutionJobs in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+dataformRepositorySource,
+directNotebookSource,
+displayName,
+encryptionSpec,
+executionTimeout,
+executionUser,
+gcsNotebookSource,
+gcsOutputUri,
+jobState,
+labels,
+notebookRuntimeTemplateResourceName,
+scheduleResourceName,
+serviceAccount,
+status,
+updateTime
+FROM google.aiplatform.notebook_execution_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new notebook_execution_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.notebook_execution_jobs (
+locationsId,
+projectsId,
+updateTime,
+createTime,
+notebookRuntimeTemplateResourceName,
+executionTimeout,
+gcsOutputUri,
+serviceAccount,
+encryptionSpec,
+displayName,
+dataformRepositorySource,
+executionUser,
+scheduleResourceName,
+name,
+gcsNotebookSource,
+labels,
+directNotebookSource,
+status,
+jobState
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ updateTime }}',
+'{{ createTime }}',
+'{{ notebookRuntimeTemplateResourceName }}',
+'{{ executionTimeout }}',
+'{{ gcsOutputUri }}',
+'{{ serviceAccount }}',
+'{{ encryptionSpec }}',
+'{{ displayName }}',
+'{{ dataformRepositorySource }}',
+'{{ executionUser }}',
+'{{ scheduleResourceName }}',
+'{{ name }}',
+'{{ gcsNotebookSource }}',
+'{{ labels }}',
+'{{ directNotebookSource }}',
+'{{ status }}',
+'{{ jobState }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: notebookRuntimeTemplateResourceName
+ value: '{{ notebookRuntimeTemplateResourceName }}'
+ - name: executionTimeout
+ value: '{{ executionTimeout }}'
+ - name: gcsOutputUri
+ value: '{{ gcsOutputUri }}'
+ - name: serviceAccount
+ value: '{{ serviceAccount }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: dataformRepositorySource
+ value: '{{ dataformRepositorySource }}'
+ - name: executionUser
+ value: '{{ executionUser }}'
+ - name: scheduleResourceName
+ value: '{{ scheduleResourceName }}'
+ - name: name
+ value: '{{ name }}'
+ - name: gcsNotebookSource
+ value: '{{ gcsNotebookSource }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: directNotebookSource
+ value: '{{ directNotebookSource }}'
+ - name: status
+ value: '{{ status }}'
+ - name: jobState
+ value: '{{ jobState }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified notebook_execution_job resource.
+
+```sql
+DELETE FROM google.aiplatform.notebook_execution_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND notebookExecutionJobsId = '{{ notebookExecutionJobsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md
index 69ea7bd518..e3b1743243 100644
--- a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md
+++ b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md
@@ -1,3 +1,4 @@
+
---
title: notebook_runtime_templates
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- notebook_runtime_templates
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an notebook_runtime_template
resource or lists notebook_runtime_templates
in a region
## Overview
@@ -48,6 +50,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. |
| | `object` | A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). |
| | `string` | Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -56,4 +59,182 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a NotebookRuntimeTemplate. |
| | `DELETE` | | Deletes a NotebookRuntimeTemplate. |
| | `UPDATE` | | Updates a NotebookRuntimeTemplate. |
-| | `EXEC` | | Lists NotebookRuntimeTemplates in a Location. |
+
+## `SELECT` examples
+
+Lists NotebookRuntimeTemplates in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+dataPersistentDiskSpec,
+displayName,
+encryptionSpec,
+etag,
+eucConfig,
+idleShutdownConfig,
+isDefault,
+labels,
+machineSpec,
+networkSpec,
+networkTags,
+notebookRuntimeType,
+serviceAccount,
+shieldedVmConfig,
+updateTime
+FROM google.aiplatform.notebook_runtime_templates
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new notebook_runtime_templates
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.notebook_runtime_templates (
+locationsId,
+projectsId,
+machineSpec,
+notebookRuntimeType,
+shieldedVmConfig,
+name,
+description,
+displayName,
+labels,
+eucConfig,
+encryptionSpec,
+isDefault,
+serviceAccount,
+networkSpec,
+createTime,
+idleShutdownConfig,
+etag,
+dataPersistentDiskSpec,
+updateTime,
+networkTags
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ machineSpec }}',
+'{{ notebookRuntimeType }}',
+'{{ shieldedVmConfig }}',
+'{{ name }}',
+'{{ description }}',
+'{{ displayName }}',
+'{{ labels }}',
+'{{ eucConfig }}',
+'{{ encryptionSpec }}',
+true|false,
+'{{ serviceAccount }}',
+'{{ networkSpec }}',
+'{{ createTime }}',
+'{{ idleShutdownConfig }}',
+'{{ etag }}',
+'{{ dataPersistentDiskSpec }}',
+'{{ updateTime }}',
+'{{ networkTags }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: machineSpec
+ value: '{{ machineSpec }}'
+ - name: notebookRuntimeType
+ value: '{{ notebookRuntimeType }}'
+ - name: shieldedVmConfig
+ value: '{{ shieldedVmConfig }}'
+ - name: name
+ value: '{{ name }}'
+ - name: description
+ value: '{{ description }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: eucConfig
+ value: '{{ eucConfig }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: isDefault
+ value: '{{ isDefault }}'
+ - name: serviceAccount
+ value: '{{ serviceAccount }}'
+ - name: networkSpec
+ value: '{{ networkSpec }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: idleShutdownConfig
+ value: '{{ idleShutdownConfig }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: dataPersistentDiskSpec
+ value: '{{ dataPersistentDiskSpec }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: networkTags
+ value: '{{ networkTags }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a notebook_runtime_template only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.notebook_runtime_templates
+SET
+machineSpec = '{{ machineSpec }}',
+notebookRuntimeType = '{{ notebookRuntimeType }}',
+shieldedVmConfig = '{{ shieldedVmConfig }}',
+name = '{{ name }}',
+description = '{{ description }}',
+displayName = '{{ displayName }}',
+labels = '{{ labels }}',
+eucConfig = '{{ eucConfig }}',
+encryptionSpec = '{{ encryptionSpec }}',
+isDefault = true|false,
+serviceAccount = '{{ serviceAccount }}',
+networkSpec = '{{ networkSpec }}',
+createTime = '{{ createTime }}',
+idleShutdownConfig = '{{ idleShutdownConfig }}',
+etag = '{{ etag }}',
+dataPersistentDiskSpec = '{{ dataPersistentDiskSpec }}',
+updateTime = '{{ updateTime }}',
+networkTags = '{{ networkTags }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified notebook_runtime_template resource.
+
+```sql
+DELETE FROM google.aiplatform.notebook_runtime_templates
+WHERE locationsId = '{{ locationsId }}'
+AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates_iam_policies/index.md
index 15b32f0f19..474b2886e4 100644
--- a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates_iam_policies/index.md
+++ b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: notebook_runtime_templates_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- notebook_runtime_templates_iam_policies
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an notebook_runtime_templates_iam_policy
resource or lists notebook_runtime_templates_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.aiplatform.notebook_runtime_templates_iam_policies
+WHERE locationsId = '{{ locationsId }}'
+AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/notebook_runtimes/index.md b/docs/google-docs/providers/google/aiplatform/notebook_runtimes/index.md
index 4662b654f6..478ac06975 100644
--- a/docs/google-docs/providers/google/aiplatform/notebook_runtimes/index.md
+++ b/docs/google-docs/providers/google/aiplatform/notebook_runtimes/index.md
@@ -1,3 +1,4 @@
+
---
title: notebook_runtimes
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- notebook_runtimes
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an notebook_runtime
resource or lists notebook_runtimes
in a region
## Overview
@@ -51,13 +53,56 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The service account that the NotebookRuntime workload runs as. |
| | `string` | Output only. Timestamp when this NotebookRuntime was most recently updated. |
| | `string` | Output only. The VM os image version of NotebookRuntime. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a NotebookRuntime. |
| | `SELECT` | | Lists NotebookRuntimes in a Location. |
| | `DELETE` | | Deletes a NotebookRuntime. |
-| | `EXEC` | | Lists NotebookRuntimes in a Location. |
| | `EXEC` | | Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. |
| | `EXEC` | | Starts a NotebookRuntime. |
| | `EXEC` | | Upgrades a NotebookRuntime. |
+
+## `SELECT` examples
+
+Lists NotebookRuntimes in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+encryptionSpec,
+expirationTime,
+healthState,
+idleShutdownConfig,
+isUpgradable,
+labels,
+networkTags,
+notebookRuntimeTemplateRef,
+notebookRuntimeType,
+proxyUri,
+runtimeState,
+runtimeUser,
+satisfiesPzi,
+satisfiesPzs,
+serviceAccount,
+updateTime,
+version
+FROM google.aiplatform.notebook_runtimes
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified notebook_runtime resource.
+
+```sql
+DELETE FROM google.aiplatform.notebook_runtimes
+WHERE locationsId = '{{ locationsId }}'
+AND notebookRuntimesId = '{{ notebookRuntimesId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/operations/index.md b/docs/google-docs/providers/google/aiplatform/operations/index.md
index 1f555fe5ae..4050164b67 100644
--- a/docs/google-docs/providers/google/aiplatform/operations/index.md
+++ b/docs/google-docs/providers/google/aiplatform/operations/index.md
@@ -1,3 +1,4 @@
+
---
title: operations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- operations
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an operation
resource or lists operations
in a region
## Overview
@@ -30,17 +32,48 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `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}`. |
+| | `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}`. |
| | `boolean` | 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. |
| | `object` | 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). |
| | `object` | 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. |
| | `object` | 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`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
-| | `SELECT` | | 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. |
-| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
-| | `DELETE` | | 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`. |
-| | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
-| | `EXEC` | | 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`. |
-| | `EXEC` | | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. |
+| | `SELECT` | | 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. |
+| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
+| | `DELETE` | | 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`. |
+| | `EXEC` | | 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`. |
+| | `EXEC` | | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. |
+
+## `SELECT` examples
+
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+```sql
+SELECT
+name,
+done,
+error,
+metadata,
+response
+FROM google.aiplatform.operations
+WHERE executionsId = '{{ executionsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified operation resource.
+
+```sql
+DELETE FROM google.aiplatform.operations
+WHERE executionsId = '{{ executionsId }}'
+AND locationsId = '{{ locationsId }}'
+AND metadataStoresId = '{{ metadataStoresId }}'
+AND operationsId = '{{ operationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/operations_wait/index.md b/docs/google-docs/providers/google/aiplatform/operations_wait/index.md
index 2fa4ad892d..fa7585f305 100644
--- a/docs/google-docs/providers/google/aiplatform/operations_wait/index.md
+++ b/docs/google-docs/providers/google/aiplatform/operations_wait/index.md
@@ -1,3 +1,4 @@
+
---
title: operations_wait
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- operations_wait
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an operations_wait
resource or lists operations_wait
in a region
## Overview
@@ -30,13 +32,32 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `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}`. |
+| | `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}`. |
| | `boolean` | 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. |
| | `object` | 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). |
| | `object` | 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. |
| | `object` | 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`. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
+
+## `SELECT` examples
+
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+```sql
+SELECT
+name,
+done,
+error,
+metadata,
+response
+FROM google.aiplatform.operations_wait
+WHERE featureGroupsId = '{{ featureGroupsId }}'
+AND featuresId = '{{ featuresId }}'
+AND locationsId = '{{ locationsId }}'
+AND operationsId = '{{ operationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md b/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md
index a2d01f1861..5d2cb18871 100644
--- a/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md
+++ b/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md
@@ -1,3 +1,4 @@
+
---
title: persistent_resources
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- persistent_resources
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an persistent_resource
resource or lists persistent_resources
in a region
## Overview
@@ -36,14 +38,17 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. |
| | `object` | 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). |
| | `object` | Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
-| | `string` | Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. |
+| | `string` | Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. |
| | `array` | Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. |
| | `array` | Required. The spec of the pools of different resources. |
| | `object` | Persistent Cluster runtime information as output |
| | `object` | Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. |
| | `string` | Output only. The detailed state of a Study. |
| | `string` | Output only. Time when the PersistentResource was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -52,5 +57,171 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a PersistentResource. |
| | `DELETE` | | Deletes a PersistentResource. |
| | `UPDATE` | | Updates a PersistentResource. |
-| | `EXEC` | | Lists PersistentResources in a Location. |
| | `EXEC` | | Reboots a PersistentResource. |
+
+## `SELECT` examples
+
+Lists PersistentResources in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+encryptionSpec,
+error,
+labels,
+network,
+reservedIpRanges,
+resourcePools,
+resourceRuntime,
+resourceRuntimeSpec,
+satisfiesPzi,
+satisfiesPzs,
+startTime,
+state,
+updateTime
+FROM google.aiplatform.persistent_resources
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new persistent_resources
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.persistent_resources (
+locationsId,
+projectsId,
+updateTime,
+resourcePools,
+error,
+satisfiesPzs,
+displayName,
+network,
+resourceRuntimeSpec,
+createTime,
+resourceRuntime,
+state,
+satisfiesPzi,
+startTime,
+labels,
+reservedIpRanges,
+name,
+encryptionSpec
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ updateTime }}',
+'{{ resourcePools }}',
+'{{ error }}',
+true|false,
+'{{ displayName }}',
+'{{ network }}',
+'{{ resourceRuntimeSpec }}',
+'{{ createTime }}',
+'{{ resourceRuntime }}',
+'{{ state }}',
+true|false,
+'{{ startTime }}',
+'{{ labels }}',
+'{{ reservedIpRanges }}',
+'{{ name }}',
+'{{ encryptionSpec }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: resourcePools
+ value: '{{ resourcePools }}'
+ - name: error
+ value: '{{ error }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: network
+ value: '{{ network }}'
+ - name: resourceRuntimeSpec
+ value: '{{ resourceRuntimeSpec }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: resourceRuntime
+ value: '{{ resourceRuntime }}'
+ - name: state
+ value: '{{ state }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: reservedIpRanges
+ value: '{{ reservedIpRanges }}'
+ - name: name
+ value: '{{ name }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a persistent_resource only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.persistent_resources
+SET
+updateTime = '{{ updateTime }}',
+resourcePools = '{{ resourcePools }}',
+error = '{{ error }}',
+satisfiesPzs = true|false,
+displayName = '{{ displayName }}',
+network = '{{ network }}',
+resourceRuntimeSpec = '{{ resourceRuntimeSpec }}',
+createTime = '{{ createTime }}',
+resourceRuntime = '{{ resourceRuntime }}',
+state = '{{ state }}',
+satisfiesPzi = true|false,
+startTime = '{{ startTime }}',
+labels = '{{ labels }}',
+reservedIpRanges = '{{ reservedIpRanges }}',
+name = '{{ name }}',
+encryptionSpec = '{{ encryptionSpec }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND persistentResourcesId = '{{ persistentResourcesId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified persistent_resource resource.
+
+```sql
+DELETE FROM google.aiplatform.persistent_resources
+WHERE locationsId = '{{ locationsId }}'
+AND persistentResourcesId = '{{ persistentResourcesId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md
index 7f7334281e..59f887a71f 100644
--- a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: pipeline_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- pipeline_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an pipeline_job
resource or lists pipeline_jobs
in a region
## Overview
@@ -38,8 +40,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | 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). |
| | `object` | The runtime detail of PipelineJob. |
| | `object` | The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided. |
-| | `string` | The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. |
+| | `string` | The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. |
| | `object` | The spec of the pipeline. |
+| | `boolean` | Optional. Whether to do component level validations before job creation. |
| | `array` | A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. |
| | `object` | The runtime config of a PipelineJob. |
| | `string` | Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. |
@@ -49,14 +52,171 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. |
| | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. |
| | `string` | Output only. Timestamp when this PipelineJob was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a PipelineJob. |
| | `SELECT` | | Lists PipelineJobs in a Location. |
| | `INSERT` | | Creates a PipelineJob. A PipelineJob will run immediately when created. |
+| | `DELETE` | | Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. |
| | `DELETE` | | Deletes a PipelineJob. |
-| | `EXEC` | | Lists PipelineJobs in a Location. |
| | `EXEC` | | Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. |
-| | `EXEC` | | Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. |
| | `EXEC` | | Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists PipelineJobs in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+encryptionSpec,
+endTime,
+error,
+jobDetail,
+labels,
+network,
+pipelineSpec,
+preflightValidations,
+reservedIpRanges,
+runtimeConfig,
+scheduleName,
+serviceAccount,
+startTime,
+state,
+templateMetadata,
+templateUri,
+updateTime
+FROM google.aiplatform.pipeline_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new pipeline_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.pipeline_jobs (
+locationsId,
+projectsId,
+runtimeConfig,
+labels,
+templateUri,
+state,
+name,
+displayName,
+encryptionSpec,
+updateTime,
+startTime,
+createTime,
+error,
+templateMetadata,
+network,
+reservedIpRanges,
+pipelineSpec,
+preflightValidations,
+serviceAccount,
+scheduleName,
+jobDetail,
+endTime
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ runtimeConfig }}',
+'{{ labels }}',
+'{{ templateUri }}',
+'{{ state }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ encryptionSpec }}',
+'{{ updateTime }}',
+'{{ startTime }}',
+'{{ createTime }}',
+'{{ error }}',
+'{{ templateMetadata }}',
+'{{ network }}',
+'{{ reservedIpRanges }}',
+'{{ pipelineSpec }}',
+true|false,
+'{{ serviceAccount }}',
+'{{ scheduleName }}',
+'{{ jobDetail }}',
+'{{ endTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: runtimeConfig
+ value: '{{ runtimeConfig }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: templateUri
+ value: '{{ templateUri }}'
+ - name: state
+ value: '{{ state }}'
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: error
+ value: '{{ error }}'
+ - name: templateMetadata
+ value: '{{ templateMetadata }}'
+ - name: network
+ value: '{{ network }}'
+ - name: reservedIpRanges
+ value: '{{ reservedIpRanges }}'
+ - name: pipelineSpec
+ value: '{{ pipelineSpec }}'
+ - name: preflightValidations
+ value: '{{ preflightValidations }}'
+ - name: serviceAccount
+ value: '{{ serviceAccount }}'
+ - name: scheduleName
+ value: '{{ scheduleName }}'
+ - name: jobDetail
+ value: '{{ jobDetail }}'
+ - name: endTime
+ value: '{{ endTime }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified pipeline_job resource.
+
+```sql
+DELETE FROM google.aiplatform.pipeline_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/runs/index.md b/docs/google-docs/providers/google/aiplatform/runs/index.md
index 645e05af35..0c9465d989 100644
--- a/docs/google-docs/providers/google/aiplatform/runs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/runs/index.md
@@ -1,3 +1,4 @@
+
---
title: runs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- runs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an run
resource or lists runs
in a region
## Overview
@@ -30,21 +32,120 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` |
+| | `string` | Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` |
| | `string` | Description of this TensorboardRun. |
| | `string` | Output only. Timestamp when this TensorboardRun was created. |
| | `string` | Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment. |
| | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
| | `object` | The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `string` | Output only. Timestamp when this TensorboardRun was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a TensorboardRun. |
| | `SELECT` | | Lists TensorboardRuns in a Location. |
+| | `INSERT` | | Batch create TensorboardRuns. |
| | `INSERT` | | Creates a TensorboardRun. |
| | `DELETE` | | Deletes a TensorboardRun. |
| | `UPDATE` | | Updates a TensorboardRun. |
-| | `EXEC` | | Lists TensorboardRuns in a Location. |
-| | `EXEC` | | Batch create TensorboardRuns. |
| | `EXEC` | | Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. |
+
+## `SELECT` examples
+
+Lists TensorboardRuns in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+etag,
+labels,
+updateTime
+FROM google.aiplatform.runs
+WHERE experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new runs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.runs (
+experimentsId,
+locationsId,
+projectsId,
+tensorboardsId,
+requests
+)
+SELECT
+'{{ experimentsId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ tensorboardsId }}',
+'{{ requests }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: requests
+ value: '{{ requests }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a run only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.runs
+SET
+createTime = '{{ createTime }}',
+name = '{{ name }}',
+updateTime = '{{ updateTime }}',
+displayName = '{{ displayName }}',
+etag = '{{ etag }}',
+description = '{{ description }}',
+labels = '{{ labels }}'
+WHERE
+experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND runsId = '{{ runsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified run resource.
+
+```sql
+DELETE FROM google.aiplatform.runs
+WHERE experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND runsId = '{{ runsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/saved_queries/index.md b/docs/google-docs/providers/google/aiplatform/saved_queries/index.md
index 18c3f7c6ce..fa48e53376 100644
--- a/docs/google-docs/providers/google/aiplatform/saved_queries/index.md
+++ b/docs/google-docs/providers/google/aiplatform/saved_queries/index.md
@@ -1,3 +1,4 @@
+
---
title: saved_queries
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- saved_queries
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an saved_query
resource or lists saved_queries
in a region
## Overview
@@ -40,9 +42,43 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING |
| | `boolean` | Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. |
| | `string` | Output only. Timestamp when SavedQuery was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Lists SavedQueries in a Dataset. |
| | `DELETE` | | Deletes a SavedQuery. |
-| | `EXEC` | | Lists SavedQueries in a Dataset. |
+
+## `SELECT` examples
+
+Lists SavedQueries in a Dataset.
+
+```sql
+SELECT
+name,
+annotationFilter,
+annotationSpecCount,
+createTime,
+displayName,
+etag,
+metadata,
+problemType,
+supportAutomlTraining,
+updateTime
+FROM google.aiplatform.saved_queries
+WHERE datasetsId = '{{ datasetsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified saved_query resource.
+
+```sql
+DELETE FROM google.aiplatform.saved_queries
+WHERE datasetsId = '{{ datasetsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND savedQueriesId = '{{ savedQueriesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/schedules/index.md b/docs/google-docs/providers/google/aiplatform/schedules/index.md
index 8bfecadfec..13aadffadb 100644
--- a/docs/google-docs/providers/google/aiplatform/schedules/index.md
+++ b/docs/google-docs/providers/google/aiplatform/schedules/index.md
@@ -1,3 +1,4 @@
+
---
title: schedules
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- schedules
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an schedule
resource or lists schedules
in a region
## Overview
@@ -33,21 +35,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Immutable. The resource name of the Schedule. |
| | `boolean` | Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false. |
| | `boolean` | Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false. |
+| | `object` | Request message for [NotebookService.CreateNotebookExecutionJob] |
| | `object` | Request message for PipelineService.CreatePipelineJob. |
| | `string` | Output only. Timestamp when this Schedule was created. |
-| | `string` | Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". |
+| | `string` | Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". |
| | `string` | Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
-| | `string` | Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. |
+| | `string` | Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. |
| | `string` | Output only. Timestamp when this Schedule was last paused. Unset if never paused. |
| | `string` | Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. |
| | `object` | Status of a scheduled run. |
| | `string` | Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). |
-| | `string` | Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. |
+| | `string` | Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. |
| | `string` | Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule. |
| | `string` | Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. |
| | `string` | Output only. The number of runs started by this schedule. |
| | `string` | Output only. The state of this Schedule. |
| | `string` | Output only. Timestamp when this Schedule was updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -56,6 +60,190 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a Schedule. |
| | `DELETE` | | Deletes a Schedule. |
| | `UPDATE` | | Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. |
-| | `EXEC` | | Lists Schedules in a Location. |
| | `EXEC` | | Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. |
| | `EXEC` | | Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first. |
+
+## `SELECT` examples
+
+Lists Schedules in a Location.
+
+```sql
+SELECT
+name,
+allowQueueing,
+catchUp,
+createNotebookExecutionJobRequest,
+createPipelineJobRequest,
+createTime,
+cron,
+displayName,
+endTime,
+lastPauseTime,
+lastResumeTime,
+lastScheduledRunResponse,
+maxConcurrentRunCount,
+maxRunCount,
+nextRunTime,
+startTime,
+startedRunCount,
+state,
+updateTime
+FROM google.aiplatform.schedules
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new schedules
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.schedules (
+locationsId,
+projectsId,
+lastPauseTime,
+catchUp,
+maxRunCount,
+allowQueueing,
+createNotebookExecutionJobRequest,
+state,
+cron,
+endTime,
+startTime,
+createPipelineJobRequest,
+name,
+lastResumeTime,
+createTime,
+displayName,
+updateTime,
+maxConcurrentRunCount,
+nextRunTime,
+lastScheduledRunResponse,
+startedRunCount
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ lastPauseTime }}',
+true|false,
+'{{ maxRunCount }}',
+true|false,
+'{{ createNotebookExecutionJobRequest }}',
+'{{ state }}',
+'{{ cron }}',
+'{{ endTime }}',
+'{{ startTime }}',
+'{{ createPipelineJobRequest }}',
+'{{ name }}',
+'{{ lastResumeTime }}',
+'{{ createTime }}',
+'{{ displayName }}',
+'{{ updateTime }}',
+'{{ maxConcurrentRunCount }}',
+'{{ nextRunTime }}',
+'{{ lastScheduledRunResponse }}',
+'{{ startedRunCount }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: lastPauseTime
+ value: '{{ lastPauseTime }}'
+ - name: catchUp
+ value: '{{ catchUp }}'
+ - name: maxRunCount
+ value: '{{ maxRunCount }}'
+ - name: allowQueueing
+ value: '{{ allowQueueing }}'
+ - name: createNotebookExecutionJobRequest
+ value: '{{ createNotebookExecutionJobRequest }}'
+ - name: state
+ value: '{{ state }}'
+ - name: cron
+ value: '{{ cron }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: createPipelineJobRequest
+ value: '{{ createPipelineJobRequest }}'
+ - name: name
+ value: '{{ name }}'
+ - name: lastResumeTime
+ value: '{{ lastResumeTime }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: maxConcurrentRunCount
+ value: '{{ maxConcurrentRunCount }}'
+ - name: nextRunTime
+ value: '{{ nextRunTime }}'
+ - name: lastScheduledRunResponse
+ value: '{{ lastScheduledRunResponse }}'
+ - name: startedRunCount
+ value: '{{ startedRunCount }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a schedule only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.schedules
+SET
+lastPauseTime = '{{ lastPauseTime }}',
+catchUp = true|false,
+maxRunCount = '{{ maxRunCount }}',
+allowQueueing = true|false,
+createNotebookExecutionJobRequest = '{{ createNotebookExecutionJobRequest }}',
+state = '{{ state }}',
+cron = '{{ cron }}',
+endTime = '{{ endTime }}',
+startTime = '{{ startTime }}',
+createPipelineJobRequest = '{{ createPipelineJobRequest }}',
+name = '{{ name }}',
+lastResumeTime = '{{ lastResumeTime }}',
+createTime = '{{ createTime }}',
+displayName = '{{ displayName }}',
+updateTime = '{{ updateTime }}',
+maxConcurrentRunCount = '{{ maxConcurrentRunCount }}',
+nextRunTime = '{{ nextRunTime }}',
+lastScheduledRunResponse = '{{ lastScheduledRunResponse }}',
+startedRunCount = '{{ startedRunCount }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND schedulesId = '{{ schedulesId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified schedule resource.
+
+```sql
+DELETE FROM google.aiplatform.schedules
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND schedulesId = '{{ schedulesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/slices/index.md b/docs/google-docs/providers/google/aiplatform/slices/index.md
index 5a8a0e56b8..a69f97423a 100644
--- a/docs/google-docs/providers/google/aiplatform/slices/index.md
+++ b/docs/google-docs/providers/google/aiplatform/slices/index.md
@@ -1,3 +1,4 @@
+
---
title: slices
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- slices
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an slice
resource or lists slices
in a region
## Overview
@@ -36,10 +38,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). |
| | `object` | Aggregated explanation metrics for a Model over a set of instances. |
| | `object` | Definition of a slice. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a ModelEvaluationSlice. |
| | `SELECT` | | Lists ModelEvaluationSlices in a ModelEvaluation. |
-| | `EXEC` | | Lists ModelEvaluationSlices in a ModelEvaluation. |
| | `EXEC` | | Imports a list of externally generated EvaluatedAnnotations. |
+
+## `SELECT` examples
+
+Lists ModelEvaluationSlices in a ModelEvaluation.
+
+```sql
+SELECT
+name,
+createTime,
+metrics,
+metricsSchemaUri,
+modelExplanation,
+slice
+FROM google.aiplatform.slices
+WHERE evaluationsId = '{{ evaluationsId }}'
+AND locationsId = '{{ locationsId }}'
+AND modelsId = '{{ modelsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md
index 54e10db03b..1e93b5fab0 100644
--- a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md
+++ b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md
@@ -1,3 +1,4 @@
+
---
title: specialist_pools
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- specialist_pools
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an specialist_pool
resource or lists specialist_pools
in a region
## Overview
@@ -36,6 +38,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | The email addresses of the managers in the SpecialistPool. |
| | `integer` | Output only. The number of managers in this SpecialistPool. |
| | `array` | The email addresses of workers in the SpecialistPool. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -44,4 +47,110 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a SpecialistPool. |
| | `DELETE` | | Deletes a SpecialistPool as well as all Specialists in the pool. |
| | `UPDATE` | | Updates a SpecialistPool. |
-| | `EXEC` | | Lists SpecialistPools in a Location. |
+
+## `SELECT` examples
+
+Lists SpecialistPools in a Location.
+
+```sql
+SELECT
+name,
+displayName,
+pendingDataLabelingJobs,
+specialistManagerEmails,
+specialistManagersCount,
+specialistWorkerEmails
+FROM google.aiplatform.specialist_pools
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new specialist_pools
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.specialist_pools (
+locationsId,
+projectsId,
+pendingDataLabelingJobs,
+specialistManagerEmails,
+specialistManagersCount,
+specialistWorkerEmails,
+displayName,
+name
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ pendingDataLabelingJobs }}',
+'{{ specialistManagerEmails }}',
+'{{ specialistManagersCount }}',
+'{{ specialistWorkerEmails }}',
+'{{ displayName }}',
+'{{ name }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: pendingDataLabelingJobs
+ value: '{{ pendingDataLabelingJobs }}'
+ - name: specialistManagerEmails
+ value: '{{ specialistManagerEmails }}'
+ - name: specialistManagersCount
+ value: '{{ specialistManagersCount }}'
+ - name: specialistWorkerEmails
+ value: '{{ specialistWorkerEmails }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: name
+ value: '{{ name }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a specialist_pool only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.specialist_pools
+SET
+pendingDataLabelingJobs = '{{ pendingDataLabelingJobs }}',
+specialistManagerEmails = '{{ specialistManagerEmails }}',
+specialistManagersCount = '{{ specialistManagersCount }}',
+specialistWorkerEmails = '{{ specialistWorkerEmails }}',
+displayName = '{{ displayName }}',
+name = '{{ name }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND specialistPoolsId = '{{ specialistPoolsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified specialist_pool resource.
+
+```sql
+DELETE FROM google.aiplatform.specialist_pools
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND specialistPoolsId = '{{ specialistPoolsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/studies/index.md b/docs/google-docs/providers/google/aiplatform/studies/index.md
index c82660893a..83baf4a5ae 100644
--- a/docs/google-docs/providers/google/aiplatform/studies/index.md
+++ b/docs/google-docs/providers/google/aiplatform/studies/index.md
@@ -1,3 +1,4 @@
+
---
title: studies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- studies
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an study
resource or lists studies
in a region
## Overview
@@ -30,12 +32,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}` |
+| | `string` | Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}` |
| | `string` | Output only. Time at which the study was created. |
| | `string` | Required. Describes the Study, default value is empty string. |
| | `string` | Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. |
| | `string` | Output only. The detailed state of a Study. |
| | `object` | Represents specification of a Study. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,5 +46,92 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists all the studies in a region for an associated project. |
| | `INSERT` | | Creates a Study. A resource name will be generated after creation of the Study. |
| | `DELETE` | | Deletes a Study. |
-| | `EXEC` | | Lists all the studies in a region for an associated project. |
| | `EXEC` | | Looks a study up using the user-defined display_name field instead of the fully qualified resource name. |
+
+## `SELECT` examples
+
+Lists all the studies in a region for an associated project.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+inactiveReason,
+state,
+studySpec
+FROM google.aiplatform.studies
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new studies
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.studies (
+locationsId,
+projectsId,
+name,
+displayName,
+createTime,
+studySpec,
+state,
+inactiveReason
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ createTime }}',
+'{{ studySpec }}',
+'{{ state }}',
+'{{ inactiveReason }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: studySpec
+ value: '{{ studySpec }}'
+ - name: state
+ value: '{{ state }}'
+ - name: inactiveReason
+ value: '{{ inactiveReason }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified study resource.
+
+```sql
+DELETE FROM google.aiplatform.studies
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND studiesId = '{{ studiesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md
index fd425eff2c..9a01d3a73d 100644
--- a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md
+++ b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md
@@ -1,3 +1,4 @@
+
---
title: tensorboards
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- tensorboards
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an tensorboard
resource or lists tensorboards
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}` |
+| | `string` | Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}` |
| | `string` | Description of this Tensorboard. |
| | `string` | Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'. |
| | `string` | Output only. Timestamp when this Tensorboard was created. |
@@ -40,7 +42,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `boolean` | Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default. |
| | `object` | The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
| | `integer` | Output only. The number of Runs stored in this Tensorboard. |
+| | `boolean` | Output only. Reserved for future use. |
+| | `boolean` | Output only. Reserved for future use. |
| | `string` | Output only. Timestamp when this Tensorboard was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -49,7 +54,155 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a Tensorboard. |
| | `DELETE` | | Deletes a Tensorboard. |
| | `UPDATE` | | Updates a Tensorboard. |
-| | `EXEC` | | Lists Tensorboards in a Location. |
| | `EXEC` | | Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. |
| | `EXEC` | | Returns the storage size for a given TensorBoard instance. |
| | `EXEC` | | Returns a list of monthly active users for a given TensorBoard instance. |
+
+## `SELECT` examples
+
+Lists Tensorboards in a Location.
+
+```sql
+SELECT
+name,
+description,
+blobStoragePathPrefix,
+createTime,
+displayName,
+encryptionSpec,
+etag,
+isDefault,
+labels,
+runCount,
+satisfiesPzi,
+satisfiesPzs,
+updateTime
+FROM google.aiplatform.tensorboards
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new tensorboards
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.tensorboards (
+locationsId,
+projectsId,
+runCount,
+satisfiesPzi,
+createTime,
+description,
+isDefault,
+name,
+displayName,
+encryptionSpec,
+blobStoragePathPrefix,
+etag,
+updateTime,
+satisfiesPzs,
+labels
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ runCount }}',
+true|false,
+'{{ createTime }}',
+'{{ description }}',
+true|false,
+'{{ name }}',
+'{{ displayName }}',
+'{{ encryptionSpec }}',
+'{{ blobStoragePathPrefix }}',
+'{{ etag }}',
+'{{ updateTime }}',
+true|false,
+'{{ labels }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: runCount
+ value: '{{ runCount }}'
+ - name: satisfiesPzi
+ value: '{{ satisfiesPzi }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: description
+ value: '{{ description }}'
+ - name: isDefault
+ value: '{{ isDefault }}'
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: blobStoragePathPrefix
+ value: '{{ blobStoragePathPrefix }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: labels
+ value: '{{ labels }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a tensorboard only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.tensorboards
+SET
+runCount = '{{ runCount }}',
+satisfiesPzi = true|false,
+createTime = '{{ createTime }}',
+description = '{{ description }}',
+isDefault = true|false,
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+encryptionSpec = '{{ encryptionSpec }}',
+blobStoragePathPrefix = '{{ blobStoragePathPrefix }}',
+etag = '{{ etag }}',
+updateTime = '{{ updateTime }}',
+satisfiesPzs = true|false,
+labels = '{{ labels }}'
+WHERE
+locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified tensorboard resource.
+
+```sql
+DELETE FROM google.aiplatform.tensorboards
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/time_series/index.md b/docs/google-docs/providers/google/aiplatform/time_series/index.md
index b6eb550500..91e513411d 100644
--- a/docs/google-docs/providers/google/aiplatform/time_series/index.md
+++ b/docs/google-docs/providers/google/aiplatform/time_series/index.md
@@ -1,3 +1,4 @@
+
---
title: time_series
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- time_series
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an time_sery
resource or lists time_series
in a region
## Overview
@@ -40,6 +42,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob |
| | `string` | Output only. Timestamp when this TensorboardTimeSeries was last updated. |
| | `string` | Required. Immutable. Type of TensorboardTimeSeries value. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -48,7 +51,152 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a TensorboardTimeSeries. |
| | `DELETE` | | Deletes a TensorboardTimeSeries. |
| | `UPDATE` | | Updates a TensorboardTimeSeries. |
-| | `EXEC` | | Lists TensorboardTimeSeries in a Location. |
| | `EXEC` | | Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. |
| | `EXEC` | | Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. |
| | `EXEC` | | Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. |
+
+## `SELECT` examples
+
+Lists TensorboardTimeSeries in a Location.
+
+```sql
+SELECT
+name,
+description,
+createTime,
+displayName,
+etag,
+metadata,
+pluginData,
+pluginName,
+updateTime,
+valueType
+FROM google.aiplatform.time_series
+WHERE experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND runsId = '{{ runsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new time_series
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.time_series (
+experimentsId,
+locationsId,
+projectsId,
+runsId,
+tensorboardsId,
+description,
+createTime,
+pluginName,
+pluginData,
+metadata,
+updateTime,
+name,
+valueType,
+etag,
+displayName
+)
+SELECT
+'{{ experimentsId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ runsId }}',
+'{{ tensorboardsId }}',
+'{{ description }}',
+'{{ createTime }}',
+'{{ pluginName }}',
+'{{ pluginData }}',
+'{{ metadata }}',
+'{{ updateTime }}',
+'{{ name }}',
+'{{ valueType }}',
+'{{ etag }}',
+'{{ displayName }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: description
+ value: '{{ description }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: pluginName
+ value: '{{ pluginName }}'
+ - name: pluginData
+ value: '{{ pluginData }}'
+ - name: metadata
+ value: '{{ metadata }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: name
+ value: '{{ name }}'
+ - name: valueType
+ value: '{{ valueType }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: displayName
+ value: '{{ displayName }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a time_sery only if the necessary resources are available.
+
+```sql
+UPDATE google.aiplatform.time_series
+SET
+description = '{{ description }}',
+createTime = '{{ createTime }}',
+pluginName = '{{ pluginName }}',
+pluginData = '{{ pluginData }}',
+metadata = '{{ metadata }}',
+updateTime = '{{ updateTime }}',
+name = '{{ name }}',
+valueType = '{{ valueType }}',
+etag = '{{ etag }}',
+displayName = '{{ displayName }}'
+WHERE
+experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND runsId = '{{ runsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}'
+AND timeSeriesId = '{{ timeSeriesId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified time_sery resource.
+
+```sql
+DELETE FROM google.aiplatform.time_series
+WHERE experimentsId = '{{ experimentsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND runsId = '{{ runsId }}'
+AND tensorboardsId = '{{ tensorboardsId }}'
+AND timeSeriesId = '{{ timeSeriesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md
index 50c7e421d1..8f38c76dde 100644
--- a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md
+++ b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md
@@ -1,3 +1,4 @@
+
---
title: training_pipelines
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- training_pipelines
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an training_pipeline
resource or lists training_pipelines
in a region
## Overview
@@ -47,6 +49,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `any` | Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`. |
| | `any` | Output only. The metadata information as specified in the training_task_definition's `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains `metadata` object. |
| | `string` | Output only. Time when the TrainingPipeline was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -54,5 +57,147 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists TrainingPipelines in a Location. |
| | `INSERT` | | Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. |
| | `DELETE` | | Deletes a TrainingPipeline. |
-| | `EXEC` | | Lists TrainingPipelines in a Location. |
| | `EXEC` | | Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists TrainingPipelines in a Location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+encryptionSpec,
+endTime,
+error,
+inputDataConfig,
+labels,
+modelId,
+modelToUpload,
+parentModel,
+startTime,
+state,
+trainingTaskDefinition,
+trainingTaskInputs,
+trainingTaskMetadata,
+updateTime
+FROM google.aiplatform.training_pipelines
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new training_pipelines
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.training_pipelines (
+locationsId,
+projectsId,
+createTime,
+startTime,
+trainingTaskDefinition,
+inputDataConfig,
+trainingTaskMetadata,
+parentModel,
+endTime,
+modelToUpload,
+updateTime,
+labels,
+modelId,
+state,
+encryptionSpec,
+trainingTaskInputs,
+displayName,
+name,
+error
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ createTime }}',
+'{{ startTime }}',
+'{{ trainingTaskDefinition }}',
+'{{ inputDataConfig }}',
+'{{ trainingTaskMetadata }}',
+'{{ parentModel }}',
+'{{ endTime }}',
+'{{ modelToUpload }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ modelId }}',
+'{{ state }}',
+'{{ encryptionSpec }}',
+'{{ trainingTaskInputs }}',
+'{{ displayName }}',
+'{{ name }}',
+'{{ error }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: trainingTaskDefinition
+ value: '{{ trainingTaskDefinition }}'
+ - name: inputDataConfig
+ value: '{{ inputDataConfig }}'
+ - name: trainingTaskMetadata
+ value: '{{ trainingTaskMetadata }}'
+ - name: parentModel
+ value: '{{ parentModel }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: modelToUpload
+ value: '{{ modelToUpload }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: modelId
+ value: '{{ modelId }}'
+ - name: state
+ value: '{{ state }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: trainingTaskInputs
+ value: '{{ trainingTaskInputs }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: name
+ value: '{{ name }}'
+ - name: error
+ value: '{{ error }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified training_pipeline resource.
+
+```sql
+DELETE FROM google.aiplatform.training_pipelines
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND trainingPipelinesId = '{{ trainingPipelinesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/trials/index.md b/docs/google-docs/providers/google/aiplatform/trials/index.md
index 42422dd885..bb8fe6bed6 100644
--- a/docs/google-docs/providers/google/aiplatform/trials/index.md
+++ b/docs/google-docs/providers/google/aiplatform/trials/index.md
@@ -1,3 +1,4 @@
+
---
title: trials
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- trials
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an trial
resource or lists trials
in a region
## Overview
@@ -42,6 +44,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Time when the Trial was started. |
| | `string` | Output only. The detailed state of the Trial. |
| | `object` | Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -49,8 +52,129 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists the Trials associated with a Study. |
| | `INSERT` | | Adds a user provided Trial to a Study. |
| | `DELETE` | | Deletes a Trial. |
-| | `EXEC` | | Lists the Trials associated with a Study. |
| | `EXEC` | | Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. |
| | `EXEC` | | Marks a Trial as complete. |
| | `EXEC` | | Stops a Trial. |
| | `EXEC` | | Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. |
+
+## `SELECT` examples
+
+Lists the Trials associated with a Study.
+
+```sql
+SELECT
+id,
+name,
+clientId,
+customJob,
+endTime,
+finalMeasurement,
+infeasibleReason,
+measurements,
+parameters,
+startTime,
+state,
+webAccessUris
+FROM google.aiplatform.trials
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND studiesId = '{{ studiesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new trials
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.trials (
+locationsId,
+projectsId,
+studiesId,
+state,
+startTime,
+finalMeasurement,
+clientId,
+id,
+measurements,
+webAccessUris,
+parameters,
+endTime,
+infeasibleReason,
+name,
+customJob
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ studiesId }}',
+'{{ state }}',
+'{{ startTime }}',
+'{{ finalMeasurement }}',
+'{{ clientId }}',
+'{{ id }}',
+'{{ measurements }}',
+'{{ webAccessUris }}',
+'{{ parameters }}',
+'{{ endTime }}',
+'{{ infeasibleReason }}',
+'{{ name }}',
+'{{ customJob }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: state
+ value: '{{ state }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: finalMeasurement
+ value: '{{ finalMeasurement }}'
+ - name: clientId
+ value: '{{ clientId }}'
+ - name: id
+ value: '{{ id }}'
+ - name: measurements
+ value: '{{ measurements }}'
+ - name: webAccessUris
+ value: '{{ webAccessUris }}'
+ - name: parameters
+ value: '{{ parameters }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: infeasibleReason
+ value: '{{ infeasibleReason }}'
+ - name: name
+ value: '{{ name }}'
+ - name: customJob
+ value: '{{ customJob }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified trial resource.
+
+```sql
+DELETE FROM google.aiplatform.trials
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND studiesId = '{{ studiesId }}'
+AND trialsId = '{{ trialsId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md b/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md
index cca19fbf3b..91837da3de 100644
--- a/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md
+++ b/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md
@@ -1,3 +1,4 @@
+
---
title: trials_optimal_trials
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- trials_optimal_trials
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an trials_optimal_trial
resource or lists trials_optimal_trials
in a region
## Overview
@@ -28,8 +30,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `array` | The pareto-optimal Trials for multiple objective Study or the optimal trial for single objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency |
+
+## `SELECT` examples
+
+Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
+
+```sql
+SELECT
+optimalTrials
+FROM google.aiplatform.trials_optimal_trials
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND studiesId = '{{ studiesId }}';
+```
diff --git a/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md b/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md
index e1eaba49f6..688c504a3a 100644
--- a/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md
+++ b/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md
@@ -1,3 +1,4 @@
+
---
title: trials_trial_measurement
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- trials_trial_measurement
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an trials_trial_measurement
resource or lists trials_trial_measurement
in a region
## Overview
@@ -28,8 +30,54 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new trials_trial_measurement
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.trials_trial_measurement (
+locationsId,
+projectsId,
+studiesId,
+trialsId,
+measurement
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ studiesId }}',
+'{{ trialsId }}',
+'{{ measurement }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: measurement
+ value: '{{ measurement }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md b/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md
index 76e71175ab..f69820f06f 100644
--- a/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md
+++ b/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md
@@ -1,3 +1,4 @@
+
---
title: tuning_jobs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- tuning_jobs
- aiplatform
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an tuning_job
resource or lists tuning_jobs
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` |
+| | `string` | Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` |
| | `string` | Optional. The description of the TuningJob. |
| | `string` | The base model that is being tuned, e.g., "gemini-1.0-pro-002". |
| | `string` | Output only. Time when the TuningJob was created. |
@@ -46,11 +48,138 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
| | `object` | The tuning data statistic values for TuningJob. |
| | `string` | Output only. Time when the TuningJob was most recently updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a TuningJob. |
| | `SELECT` | | Lists TuningJobs in a Location. |
| | `INSERT` | | Creates a TuningJob. A created TuningJob right away will be attempted to be run. |
-| | `EXEC` | | Lists TuningJobs in a Location. |
| | `EXEC` | | Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. |
+
+## `SELECT` examples
+
+Lists TuningJobs in a Location.
+
+```sql
+SELECT
+name,
+description,
+baseModel,
+createTime,
+encryptionSpec,
+endTime,
+error,
+experiment,
+labels,
+startTime,
+state,
+supervisedTuningSpec,
+tunedModel,
+tunedModelDisplayName,
+tuningDataStats,
+updateTime
+FROM google.aiplatform.tuning_jobs
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new tuning_jobs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.aiplatform.tuning_jobs (
+locationsId,
+projectsId,
+supervisedTuningSpec,
+tuningDataStats,
+name,
+state,
+updateTime,
+tunedModel,
+encryptionSpec,
+tunedModelDisplayName,
+endTime,
+experiment,
+error,
+description,
+startTime,
+createTime,
+baseModel,
+labels
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ supervisedTuningSpec }}',
+'{{ tuningDataStats }}',
+'{{ name }}',
+'{{ state }}',
+'{{ updateTime }}',
+'{{ tunedModel }}',
+'{{ encryptionSpec }}',
+'{{ tunedModelDisplayName }}',
+'{{ endTime }}',
+'{{ experiment }}',
+'{{ error }}',
+'{{ description }}',
+'{{ startTime }}',
+'{{ createTime }}',
+'{{ baseModel }}',
+'{{ labels }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: supervisedTuningSpec
+ value: '{{ supervisedTuningSpec }}'
+ - name: tuningDataStats
+ value: '{{ tuningDataStats }}'
+ - name: name
+ value: '{{ name }}'
+ - name: state
+ value: '{{ state }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: tunedModel
+ value: '{{ tunedModel }}'
+ - name: encryptionSpec
+ value: '{{ encryptionSpec }}'
+ - name: tunedModelDisplayName
+ value: '{{ tunedModelDisplayName }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: experiment
+ value: '{{ experiment }}'
+ - name: error
+ value: '{{ error }}'
+ - name: description
+ value: '{{ description }}'
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: baseModel
+ value: '{{ baseModel }}'
+ - name: labels
+ value: '{{ labels }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/airquality/current_conditions/index.md b/docs/google-docs/providers/google/airquality/current_conditions/index.md
new file mode 100644
index 0000000000..7e31900ced
--- /dev/null
+++ b/docs/google-docs/providers/google/airquality/current_conditions/index.md
@@ -0,0 +1,39 @@
+
+---
+title: current_conditions
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - current_conditions
+ - airquality
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an current_condition
resource or lists current_conditions
in a region
+
+## Overview
+
+Name | current_conditions |
+Type | Resource |
+Id | |
+
+
+## Fields
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | The Current Conditions endpoint provides hourly air quality information in more than 100 countries, up to a 500 x 500 meters resolution. Includes over 70 local indexes and global air quality index and categories. |
diff --git a/docs/google-docs/providers/google/airquality/forecast/index.md b/docs/google-docs/providers/google/airquality/forecast/index.md
new file mode 100644
index 0000000000..126c85a2de
--- /dev/null
+++ b/docs/google-docs/providers/google/airquality/forecast/index.md
@@ -0,0 +1,39 @@
+
+---
+title: forecast
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - forecast
+ - airquality
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an forecast
resource or lists forecast
in a region
+
+## Overview
+
+Name | forecast |
+Type | Resource |
+Id | |
+
+
+## Fields
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Returns air quality forecast for a specific location for a given time range. |
diff --git a/docs/google-docs/providers/google/airquality/heatmap_tiles/index.md b/docs/google-docs/providers/google/airquality/heatmap_tiles/index.md
new file mode 100644
index 0000000000..c2b877325b
--- /dev/null
+++ b/docs/google-docs/providers/google/airquality/heatmap_tiles/index.md
@@ -0,0 +1,39 @@
+
+---
+title: heatmap_tiles
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - heatmap_tiles
+ - airquality
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an heatmap_tile
resource or lists heatmap_tiles
in a region
+
+## Overview
+
+Name | heatmap_tiles |
+Type | Resource |
+Id | |
+
+
+## Fields
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Returns a bytes array containing the data of the tile PNG image. |
diff --git a/docs/google-docs/providers/google/airquality/history/index.md b/docs/google-docs/providers/google/airquality/history/index.md
new file mode 100644
index 0000000000..de0be5b387
--- /dev/null
+++ b/docs/google-docs/providers/google/airquality/history/index.md
@@ -0,0 +1,39 @@
+
+---
+title: history
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - history
+ - airquality
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an history
resource or lists history
in a region
+
+## Overview
+
+Name | history |
+Type | Resource |
+Id | |
+
+
+## Fields
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Returns air quality history for a specific location for a given time range. |
diff --git a/docs/google-docs/providers/google/airquality/index.md b/docs/google-docs/providers/google/airquality/index.md
new file mode 100644
index 0000000000..7e002be877
--- /dev/null
+++ b/docs/google-docs/providers/google/airquality/index.md
@@ -0,0 +1,39 @@
+---
+title: airquality
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - airquality
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage google resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+The airquality service documentation.
+
+:::info Service Summary
+
+
+
+total resources: 4
+
+
+
+:::
+
+## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/alloydb/backups/index.md b/docs/google-docs/providers/google/alloydb/backups/index.md
index 979caf3163..542ab9c68e 100644
--- a/docs/google-docs/providers/google/alloydb/backups/index.md
+++ b/docs/google-docs/providers/google/alloydb/backups/index.md
@@ -1,3 +1,4 @@
+
---
title: backups
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- backups
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an backup
resource or lists backups
in a region
## Overview
@@ -30,10 +32,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region} |
+| | `string` | Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region} |
| | `string` | User-provided description of the backup. |
| | `object` | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
-| | `string` | Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}). |
+| | `string` | Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}). |
| | `string` | Output only. The system-generated UID of the cluster which was used to create this resource. |
| | `string` | Output only. Create time stamp |
| | `string` | Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version. |
@@ -52,6 +54,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The backup type, which suggests the trigger for the backup. |
| | `string` | Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. |
| | `string` | Output only. Update time stamp |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -60,4 +63,206 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Backup in a given project and location. |
| | `DELETE` | | Deletes a single Backup. |
| | `UPDATE` | | Updates the parameters of a single Backup. |
-| | `EXEC` | | Lists Backups in a given project and location. |
+
+## `SELECT` examples
+
+Lists Backups in a given project and location.
+
+```sql
+SELECT
+name,
+description,
+annotations,
+clusterName,
+clusterUid,
+createTime,
+databaseVersion,
+deleteTime,
+displayName,
+encryptionConfig,
+encryptionInfo,
+etag,
+expiryQuantity,
+expiryTime,
+labels,
+reconciling,
+satisfiesPzs,
+sizeBytes,
+state,
+type,
+uid,
+updateTime
+FROM google.alloydb.backups
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new backups
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.backups (
+locationsId,
+projectsId,
+name,
+displayName,
+uid,
+createTime,
+updateTime,
+deleteTime,
+labels,
+state,
+type,
+description,
+clusterUid,
+clusterName,
+reconciling,
+encryptionConfig,
+encryptionInfo,
+etag,
+annotations,
+sizeBytes,
+expiryTime,
+expiryQuantity,
+satisfiesPzs,
+databaseVersion
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ uid }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ deleteTime }}',
+'{{ labels }}',
+'{{ state }}',
+'{{ type }}',
+'{{ description }}',
+'{{ clusterUid }}',
+'{{ clusterName }}',
+true|false,
+'{{ encryptionConfig }}',
+'{{ encryptionInfo }}',
+'{{ etag }}',
+'{{ annotations }}',
+'{{ sizeBytes }}',
+'{{ expiryTime }}',
+'{{ expiryQuantity }}',
+true|false,
+'{{ databaseVersion }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: uid
+ value: '{{ uid }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: deleteTime
+ value: '{{ deleteTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: state
+ value: '{{ state }}'
+ - name: type
+ value: '{{ type }}'
+ - name: description
+ value: '{{ description }}'
+ - name: clusterUid
+ value: '{{ clusterUid }}'
+ - name: clusterName
+ value: '{{ clusterName }}'
+ - name: reconciling
+ value: '{{ reconciling }}'
+ - name: encryptionConfig
+ value: '{{ encryptionConfig }}'
+ - name: encryptionInfo
+ value: '{{ encryptionInfo }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: annotations
+ value: '{{ annotations }}'
+ - name: sizeBytes
+ value: '{{ sizeBytes }}'
+ - name: expiryTime
+ value: '{{ expiryTime }}'
+ - name: expiryQuantity
+ value: '{{ expiryQuantity }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: databaseVersion
+ value: '{{ databaseVersion }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a backup only if the necessary resources are available.
+
+```sql
+UPDATE google.alloydb.backups
+SET
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+uid = '{{ uid }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+deleteTime = '{{ deleteTime }}',
+labels = '{{ labels }}',
+state = '{{ state }}',
+type = '{{ type }}',
+description = '{{ description }}',
+clusterUid = '{{ clusterUid }}',
+clusterName = '{{ clusterName }}',
+reconciling = true|false,
+encryptionConfig = '{{ encryptionConfig }}',
+encryptionInfo = '{{ encryptionInfo }}',
+etag = '{{ etag }}',
+annotations = '{{ annotations }}',
+sizeBytes = '{{ sizeBytes }}',
+expiryTime = '{{ expiryTime }}',
+expiryQuantity = '{{ expiryQuantity }}',
+satisfiesPzs = true|false,
+databaseVersion = '{{ databaseVersion }}'
+WHERE
+backupsId = '{{ backupsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified backup resource.
+
+```sql
+DELETE FROM google.alloydb.backups
+WHERE backupsId = '{{ backupsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/clusters/index.md b/docs/google-docs/providers/google/alloydb/clusters/index.md
index 5191012939..99965f9c60 100644
--- a/docs/google-docs/providers/google/alloydb/clusters/index.md
+++ b/docs/google-docs/providers/google/alloydb/clusters/index.md
@@ -1,3 +1,4 @@
+
---
title: clusters
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- clusters
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an cluster
resource or lists clusters
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} |
+| | `string` | Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region} |
| | `object` | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
| | `object` | Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set. |
| | `object` | Message describing a BackupSource. |
@@ -49,7 +51,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead. |
| | `object` | MaintenanceUpdatePolicy defines the policy for system updates. |
| | `object` | Subset of the source instance configuration that is available when reading the cluster resource. |
-| | `string` | Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. |
+| | `string` | Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project}/global/networks/{network_id}`. This is required to create a cluster. Deprecated, use network_config.network instead. |
| | `object` | Metadata related to network configuration. |
| | `object` | Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY. |
| | `object` | PscConfig contains PSC related configuration at a cluster level. |
@@ -58,8 +60,11 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY. |
| | `object` | SSL configuration. |
| | `string` | Output only. The current serving state of the cluster. |
+| | `string` | Optional. Subscription type of the cluster. |
+| | `object` | Contains information and all metadata related to TRIAL clusters. |
| | `string` | Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. |
| | `string` | Output only. Update time stamp |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -68,6 +73,270 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Cluster in a given project and location. |
| | `DELETE` | | Deletes a single Cluster. |
| | `UPDATE` | | Updates the parameters of a single Cluster. |
-| | `EXEC` | | Lists Clusters in a given project and location. |
| | `EXEC` | | Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only. |
| | `EXEC` | | Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster. |
+| | `EXEC` | | Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster. |
+| | `EXEC` | | Upgrades a single Cluster. Imperative only. |
+
+## `SELECT` examples
+
+Lists Clusters in a given project and location.
+
+```sql
+SELECT
+name,
+annotations,
+automatedBackupPolicy,
+backupSource,
+clusterType,
+continuousBackupConfig,
+continuousBackupInfo,
+createTime,
+databaseVersion,
+deleteTime,
+displayName,
+encryptionConfig,
+encryptionInfo,
+etag,
+initialUser,
+labels,
+maintenanceSchedule,
+maintenanceUpdatePolicy,
+migrationSource,
+network,
+networkConfig,
+primaryConfig,
+pscConfig,
+reconciling,
+satisfiesPzs,
+secondaryConfig,
+sslConfig,
+state,
+subscriptionType,
+trialMetadata,
+uid,
+updateTime
+FROM google.alloydb.clusters
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new clusters
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.clusters (
+locationsId,
+projectsId,
+backupSource,
+migrationSource,
+name,
+displayName,
+uid,
+createTime,
+updateTime,
+deleteTime,
+labels,
+state,
+clusterType,
+databaseVersion,
+networkConfig,
+network,
+etag,
+annotations,
+reconciling,
+initialUser,
+automatedBackupPolicy,
+sslConfig,
+encryptionConfig,
+encryptionInfo,
+continuousBackupConfig,
+continuousBackupInfo,
+secondaryConfig,
+primaryConfig,
+satisfiesPzs,
+pscConfig,
+maintenanceUpdatePolicy,
+maintenanceSchedule,
+subscriptionType,
+trialMetadata
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ backupSource }}',
+'{{ migrationSource }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ uid }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ deleteTime }}',
+'{{ labels }}',
+'{{ state }}',
+'{{ clusterType }}',
+'{{ databaseVersion }}',
+'{{ networkConfig }}',
+'{{ network }}',
+'{{ etag }}',
+'{{ annotations }}',
+true|false,
+'{{ initialUser }}',
+'{{ automatedBackupPolicy }}',
+'{{ sslConfig }}',
+'{{ encryptionConfig }}',
+'{{ encryptionInfo }}',
+'{{ continuousBackupConfig }}',
+'{{ continuousBackupInfo }}',
+'{{ secondaryConfig }}',
+'{{ primaryConfig }}',
+true|false,
+'{{ pscConfig }}',
+'{{ maintenanceUpdatePolicy }}',
+'{{ maintenanceSchedule }}',
+'{{ subscriptionType }}',
+'{{ trialMetadata }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: backupSource
+ value: '{{ backupSource }}'
+ - name: migrationSource
+ value: '{{ migrationSource }}'
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: uid
+ value: '{{ uid }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: deleteTime
+ value: '{{ deleteTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: state
+ value: '{{ state }}'
+ - name: clusterType
+ value: '{{ clusterType }}'
+ - name: databaseVersion
+ value: '{{ databaseVersion }}'
+ - name: networkConfig
+ value: '{{ networkConfig }}'
+ - name: network
+ value: '{{ network }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: annotations
+ value: '{{ annotations }}'
+ - name: reconciling
+ value: '{{ reconciling }}'
+ - name: initialUser
+ value: '{{ initialUser }}'
+ - name: automatedBackupPolicy
+ value: '{{ automatedBackupPolicy }}'
+ - name: sslConfig
+ value: '{{ sslConfig }}'
+ - name: encryptionConfig
+ value: '{{ encryptionConfig }}'
+ - name: encryptionInfo
+ value: '{{ encryptionInfo }}'
+ - name: continuousBackupConfig
+ value: '{{ continuousBackupConfig }}'
+ - name: continuousBackupInfo
+ value: '{{ continuousBackupInfo }}'
+ - name: secondaryConfig
+ value: '{{ secondaryConfig }}'
+ - name: primaryConfig
+ value: '{{ primaryConfig }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: pscConfig
+ value: '{{ pscConfig }}'
+ - name: maintenanceUpdatePolicy
+ value: '{{ maintenanceUpdatePolicy }}'
+ - name: maintenanceSchedule
+ value: '{{ maintenanceSchedule }}'
+ - name: subscriptionType
+ value: '{{ subscriptionType }}'
+ - name: trialMetadata
+ value: '{{ trialMetadata }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a cluster only if the necessary resources are available.
+
+```sql
+UPDATE google.alloydb.clusters
+SET
+backupSource = '{{ backupSource }}',
+migrationSource = '{{ migrationSource }}',
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+uid = '{{ uid }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+deleteTime = '{{ deleteTime }}',
+labels = '{{ labels }}',
+state = '{{ state }}',
+clusterType = '{{ clusterType }}',
+databaseVersion = '{{ databaseVersion }}',
+networkConfig = '{{ networkConfig }}',
+network = '{{ network }}',
+etag = '{{ etag }}',
+annotations = '{{ annotations }}',
+reconciling = true|false,
+initialUser = '{{ initialUser }}',
+automatedBackupPolicy = '{{ automatedBackupPolicy }}',
+sslConfig = '{{ sslConfig }}',
+encryptionConfig = '{{ encryptionConfig }}',
+encryptionInfo = '{{ encryptionInfo }}',
+continuousBackupConfig = '{{ continuousBackupConfig }}',
+continuousBackupInfo = '{{ continuousBackupInfo }}',
+secondaryConfig = '{{ secondaryConfig }}',
+primaryConfig = '{{ primaryConfig }}',
+satisfiesPzs = true|false,
+pscConfig = '{{ pscConfig }}',
+maintenanceUpdatePolicy = '{{ maintenanceUpdatePolicy }}',
+maintenanceSchedule = '{{ maintenanceSchedule }}',
+subscriptionType = '{{ subscriptionType }}',
+trialMetadata = '{{ trialMetadata }}'
+WHERE
+clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified cluster resource.
+
+```sql
+DELETE FROM google.alloydb.clusters
+WHERE clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/clusters_secondary/index.md b/docs/google-docs/providers/google/alloydb/clusters_secondary/index.md
index a200c27dba..a7b233de65 100644
--- a/docs/google-docs/providers/google/alloydb/clusters_secondary/index.md
+++ b/docs/google-docs/providers/google/alloydb/clusters_secondary/index.md
@@ -1,3 +1,4 @@
+
---
title: clusters_secondary
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- clusters_secondary
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an clusters_secondary
resource or lists clusters_secondary
in a region
## Overview
@@ -28,8 +30,174 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `INSERT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Creates a cluster of type SECONDARY in the given location using the primary cluster as the source. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new clusters_secondary
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.clusters_secondary (
+locationsId,
+projectsId,
+backupSource,
+migrationSource,
+name,
+displayName,
+uid,
+createTime,
+updateTime,
+deleteTime,
+labels,
+state,
+clusterType,
+databaseVersion,
+networkConfig,
+network,
+etag,
+annotations,
+reconciling,
+initialUser,
+automatedBackupPolicy,
+sslConfig,
+encryptionConfig,
+encryptionInfo,
+continuousBackupConfig,
+continuousBackupInfo,
+secondaryConfig,
+primaryConfig,
+satisfiesPzs,
+pscConfig,
+maintenanceUpdatePolicy,
+maintenanceSchedule,
+subscriptionType,
+trialMetadata
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ backupSource }}',
+'{{ migrationSource }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ uid }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ deleteTime }}',
+'{{ labels }}',
+'{{ state }}',
+'{{ clusterType }}',
+'{{ databaseVersion }}',
+'{{ networkConfig }}',
+'{{ network }}',
+'{{ etag }}',
+'{{ annotations }}',
+true|false,
+'{{ initialUser }}',
+'{{ automatedBackupPolicy }}',
+'{{ sslConfig }}',
+'{{ encryptionConfig }}',
+'{{ encryptionInfo }}',
+'{{ continuousBackupConfig }}',
+'{{ continuousBackupInfo }}',
+'{{ secondaryConfig }}',
+'{{ primaryConfig }}',
+true|false,
+'{{ pscConfig }}',
+'{{ maintenanceUpdatePolicy }}',
+'{{ maintenanceSchedule }}',
+'{{ subscriptionType }}',
+'{{ trialMetadata }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: backupSource
+ value: '{{ backupSource }}'
+ - name: migrationSource
+ value: '{{ migrationSource }}'
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: uid
+ value: '{{ uid }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: deleteTime
+ value: '{{ deleteTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: state
+ value: '{{ state }}'
+ - name: clusterType
+ value: '{{ clusterType }}'
+ - name: databaseVersion
+ value: '{{ databaseVersion }}'
+ - name: networkConfig
+ value: '{{ networkConfig }}'
+ - name: network
+ value: '{{ network }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: annotations
+ value: '{{ annotations }}'
+ - name: reconciling
+ value: '{{ reconciling }}'
+ - name: initialUser
+ value: '{{ initialUser }}'
+ - name: automatedBackupPolicy
+ value: '{{ automatedBackupPolicy }}'
+ - name: sslConfig
+ value: '{{ sslConfig }}'
+ - name: encryptionConfig
+ value: '{{ encryptionConfig }}'
+ - name: encryptionInfo
+ value: '{{ encryptionInfo }}'
+ - name: continuousBackupConfig
+ value: '{{ continuousBackupConfig }}'
+ - name: continuousBackupInfo
+ value: '{{ continuousBackupInfo }}'
+ - name: secondaryConfig
+ value: '{{ secondaryConfig }}'
+ - name: primaryConfig
+ value: '{{ primaryConfig }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: pscConfig
+ value: '{{ pscConfig }}'
+ - name: maintenanceUpdatePolicy
+ value: '{{ maintenanceUpdatePolicy }}'
+ - name: maintenanceSchedule
+ value: '{{ maintenanceSchedule }}'
+ - name: subscriptionType
+ value: '{{ subscriptionType }}'
+ - name: trialMetadata
+ value: '{{ trialMetadata }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/alloydb/index.md b/docs/google-docs/providers/google/alloydb/index.md
index 6f0710b97c..a1d0daad2c 100644
--- a/docs/google-docs/providers/google/alloydb/index.md
+++ b/docs/google-docs/providers/google/alloydb/index.md
@@ -9,34 +9,23 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
-
+The alloydb service documentation.
+
:::info Service Summary
total resources: 10
-total selectable resources: 8
-total methods: 42
:::
-## Overview
-
-Name | google.alloydb |
-Type | Service |
-Title | AlloyDB API |
-Description | AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. |
-Id | alloydb:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/alloydb/instances/index.md b/docs/google-docs/providers/google/alloydb/instances/index.md
index f86acea534..56c3803b0d 100644
--- a/docs/google-docs/providers/google/alloydb/instances/index.md
+++ b/docs/google-docs/providers/google/alloydb/instances/index.md
@@ -1,3 +1,4 @@
+
---
title: instances
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- instances
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an instance
resource or lists instances
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} |
+| | `string` | Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id} |
| | `object` | Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 |
| | `string` | Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones). |
| | `object` | Client connection configuration |
@@ -46,6 +48,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | MachineConfig describes the configuration of a machine. |
| | `object` | Metadata related to instance level network configuration. |
| | `array` | Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. |
+| | `array` | Output only. All outbound public IP addresses configured for the instance. |
| | `object` | PscInstanceConfig contains PSC related configuration at an instance level. |
| | `string` | Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. |
| | `object` | QueryInsights Instance specific configuration. |
@@ -56,6 +59,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. |
| | `string` | Output only. Update time stamp |
| | `object` | Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -64,7 +68,244 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Instance in a given project and location. |
| | `DELETE` | | Deletes a single Instance. |
| | `UPDATE` | | Updates the parameters of a single Instance. |
-| | `EXEC` | | Lists Instances in a given project and location. |
| | `EXEC` | | Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only. |
| | `EXEC` | | Injects fault in an instance. Imperative only. |
| | `EXEC` | | Restart an Instance in a cluster. Imperative only. |
+
+## `SELECT` examples
+
+Lists Instances in a given project and location.
+
+```sql
+SELECT
+name,
+annotations,
+availabilityType,
+clientConnectionConfig,
+createTime,
+databaseFlags,
+deleteTime,
+displayName,
+etag,
+gceZone,
+instanceType,
+ipAddress,
+labels,
+machineConfig,
+networkConfig,
+nodes,
+outboundPublicIpAddresses,
+pscInstanceConfig,
+publicIpAddress,
+queryInsightsConfig,
+readPoolConfig,
+reconciling,
+satisfiesPzs,
+state,
+uid,
+updateTime,
+writableNode
+FROM google.alloydb.instances
+WHERE clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new instances
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.instances (
+clustersId,
+locationsId,
+projectsId,
+name,
+displayName,
+uid,
+createTime,
+updateTime,
+deleteTime,
+labels,
+state,
+instanceType,
+machineConfig,
+availabilityType,
+gceZone,
+databaseFlags,
+writableNode,
+nodes,
+queryInsightsConfig,
+readPoolConfig,
+ipAddress,
+publicIpAddress,
+reconciling,
+etag,
+annotations,
+clientConnectionConfig,
+satisfiesPzs,
+pscInstanceConfig,
+networkConfig,
+outboundPublicIpAddresses
+)
+SELECT
+'{{ clustersId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ uid }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ deleteTime }}',
+'{{ labels }}',
+'{{ state }}',
+'{{ instanceType }}',
+'{{ machineConfig }}',
+'{{ availabilityType }}',
+'{{ gceZone }}',
+'{{ databaseFlags }}',
+'{{ writableNode }}',
+'{{ nodes }}',
+'{{ queryInsightsConfig }}',
+'{{ readPoolConfig }}',
+'{{ ipAddress }}',
+'{{ publicIpAddress }}',
+true|false,
+'{{ etag }}',
+'{{ annotations }}',
+'{{ clientConnectionConfig }}',
+true|false,
+'{{ pscInstanceConfig }}',
+'{{ networkConfig }}',
+'{{ outboundPublicIpAddresses }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: uid
+ value: '{{ uid }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: deleteTime
+ value: '{{ deleteTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: state
+ value: '{{ state }}'
+ - name: instanceType
+ value: '{{ instanceType }}'
+ - name: machineConfig
+ value: '{{ machineConfig }}'
+ - name: availabilityType
+ value: '{{ availabilityType }}'
+ - name: gceZone
+ value: '{{ gceZone }}'
+ - name: databaseFlags
+ value: '{{ databaseFlags }}'
+ - name: writableNode
+ value: '{{ writableNode }}'
+ - name: nodes
+ value: '{{ nodes }}'
+ - name: queryInsightsConfig
+ value: '{{ queryInsightsConfig }}'
+ - name: readPoolConfig
+ value: '{{ readPoolConfig }}'
+ - name: ipAddress
+ value: '{{ ipAddress }}'
+ - name: publicIpAddress
+ value: '{{ publicIpAddress }}'
+ - name: reconciling
+ value: '{{ reconciling }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: annotations
+ value: '{{ annotations }}'
+ - name: clientConnectionConfig
+ value: '{{ clientConnectionConfig }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: pscInstanceConfig
+ value: '{{ pscInstanceConfig }}'
+ - name: networkConfig
+ value: '{{ networkConfig }}'
+ - name: outboundPublicIpAddresses
+ value: '{{ outboundPublicIpAddresses }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a instance only if the necessary resources are available.
+
+```sql
+UPDATE google.alloydb.instances
+SET
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+uid = '{{ uid }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+deleteTime = '{{ deleteTime }}',
+labels = '{{ labels }}',
+state = '{{ state }}',
+instanceType = '{{ instanceType }}',
+machineConfig = '{{ machineConfig }}',
+availabilityType = '{{ availabilityType }}',
+gceZone = '{{ gceZone }}',
+databaseFlags = '{{ databaseFlags }}',
+writableNode = '{{ writableNode }}',
+nodes = '{{ nodes }}',
+queryInsightsConfig = '{{ queryInsightsConfig }}',
+readPoolConfig = '{{ readPoolConfig }}',
+ipAddress = '{{ ipAddress }}',
+publicIpAddress = '{{ publicIpAddress }}',
+reconciling = true|false,
+etag = '{{ etag }}',
+annotations = '{{ annotations }}',
+clientConnectionConfig = '{{ clientConnectionConfig }}',
+satisfiesPzs = true|false,
+pscInstanceConfig = '{{ pscInstanceConfig }}',
+networkConfig = '{{ networkConfig }}',
+outboundPublicIpAddresses = '{{ outboundPublicIpAddresses }}'
+WHERE
+clustersId = '{{ clustersId }}'
+AND instancesId = '{{ instancesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified instance resource.
+
+```sql
+DELETE FROM google.alloydb.instances
+WHERE clustersId = '{{ clustersId }}'
+AND instancesId = '{{ instancesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/instances_connection_info/index.md b/docs/google-docs/providers/google/alloydb/instances_connection_info/index.md
index c2bbc1ede7..f6a9a4e60e 100644
--- a/docs/google-docs/providers/google/alloydb/instances_connection_info/index.md
+++ b/docs/google-docs/providers/google/alloydb/instances_connection_info/index.md
@@ -1,3 +1,4 @@
+
---
title: instances_connection_info
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- instances_connection_info
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an instances_connection_info
resource or lists instances_connection_info
in a region
## Overview
@@ -30,11 +32,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning. |
+| | `string` | The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning. |
| | `string` | Output only. The unique ID of the Instance. |
| | `string` | Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application. |
| | `string` | Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Get instance metadata used for a connection. |
+
+## `SELECT` examples
+
+Get instance metadata used for a connection.
+
+```sql
+SELECT
+name,
+instanceUid,
+ipAddress,
+publicIpAddress
+FROM google.alloydb.instances_connection_info
+WHERE clustersId = '{{ clustersId }}'
+AND instancesId = '{{ instancesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/instances_secondary/index.md b/docs/google-docs/providers/google/alloydb/instances_secondary/index.md
index 84d7cf9cfc..9d0cf31d7a 100644
--- a/docs/google-docs/providers/google/alloydb/instances_secondary/index.md
+++ b/docs/google-docs/providers/google/alloydb/instances_secondary/index.md
@@ -1,3 +1,4 @@
+
---
title: instances_secondary
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- instances_secondary
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an instances_secondary
resource or lists instances_secondary
in a region
## Overview
@@ -28,8 +30,156 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `INSERT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Creates a new SECONDARY Instance in a given project and location. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new instances_secondary
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.instances_secondary (
+clustersId,
+locationsId,
+projectsId,
+name,
+displayName,
+uid,
+createTime,
+updateTime,
+deleteTime,
+labels,
+state,
+instanceType,
+machineConfig,
+availabilityType,
+gceZone,
+databaseFlags,
+writableNode,
+nodes,
+queryInsightsConfig,
+readPoolConfig,
+ipAddress,
+publicIpAddress,
+reconciling,
+etag,
+annotations,
+clientConnectionConfig,
+satisfiesPzs,
+pscInstanceConfig,
+networkConfig,
+outboundPublicIpAddresses
+)
+SELECT
+'{{ clustersId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ uid }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ deleteTime }}',
+'{{ labels }}',
+'{{ state }}',
+'{{ instanceType }}',
+'{{ machineConfig }}',
+'{{ availabilityType }}',
+'{{ gceZone }}',
+'{{ databaseFlags }}',
+'{{ writableNode }}',
+'{{ nodes }}',
+'{{ queryInsightsConfig }}',
+'{{ readPoolConfig }}',
+'{{ ipAddress }}',
+'{{ publicIpAddress }}',
+true|false,
+'{{ etag }}',
+'{{ annotations }}',
+'{{ clientConnectionConfig }}',
+true|false,
+'{{ pscInstanceConfig }}',
+'{{ networkConfig }}',
+'{{ outboundPublicIpAddresses }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: uid
+ value: '{{ uid }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: deleteTime
+ value: '{{ deleteTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: state
+ value: '{{ state }}'
+ - name: instanceType
+ value: '{{ instanceType }}'
+ - name: machineConfig
+ value: '{{ machineConfig }}'
+ - name: availabilityType
+ value: '{{ availabilityType }}'
+ - name: gceZone
+ value: '{{ gceZone }}'
+ - name: databaseFlags
+ value: '{{ databaseFlags }}'
+ - name: writableNode
+ value: '{{ writableNode }}'
+ - name: nodes
+ value: '{{ nodes }}'
+ - name: queryInsightsConfig
+ value: '{{ queryInsightsConfig }}'
+ - name: readPoolConfig
+ value: '{{ readPoolConfig }}'
+ - name: ipAddress
+ value: '{{ ipAddress }}'
+ - name: publicIpAddress
+ value: '{{ publicIpAddress }}'
+ - name: reconciling
+ value: '{{ reconciling }}'
+ - name: etag
+ value: '{{ etag }}'
+ - name: annotations
+ value: '{{ annotations }}'
+ - name: clientConnectionConfig
+ value: '{{ clientConnectionConfig }}'
+ - name: satisfiesPzs
+ value: '{{ satisfiesPzs }}'
+ - name: pscInstanceConfig
+ value: '{{ pscInstanceConfig }}'
+ - name: networkConfig
+ value: '{{ networkConfig }}'
+ - name: outboundPublicIpAddresses
+ value: '{{ outboundPublicIpAddresses }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/alloydb/locations/index.md b/docs/google-docs/providers/google/alloydb/locations/index.md
index a0a3ff51b0..8989f51e51 100644
--- a/docs/google-docs/providers/google/alloydb/locations/index.md
+++ b/docs/google-docs/providers/google/alloydb/locations/index.md
@@ -1,3 +1,4 @@
+
---
title: locations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- locations
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an location
resource or lists locations
in a region
## Overview
@@ -32,12 +34,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
-| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
+| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| | `string` | The canonical id for this location. For example: `"us-east1"`. |
| | `object` | Service-specific metadata. For example the available capacity at the given location. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets information about a location. |
| | `SELECT` | | Lists information about the supported locations for this service. |
-| | `EXEC` | | Lists information about the supported locations for this service. |
+
+## `SELECT` examples
+
+Lists information about the supported locations for this service.
+
+```sql
+SELECT
+name,
+displayName,
+labels,
+locationId,
+metadata
+FROM google.alloydb.locations
+WHERE projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/operations/index.md b/docs/google-docs/providers/google/alloydb/operations/index.md
index 18b2b8a3b7..4a15bc88bc 100644
--- a/docs/google-docs/providers/google/alloydb/operations/index.md
+++ b/docs/google-docs/providers/google/alloydb/operations/index.md
@@ -1,3 +1,4 @@
+
---
title: operations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- operations
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an operation
resource or lists operations
in a region
## Overview
@@ -30,16 +32,43 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `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}`. |
+| | `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}`. |
| | `boolean` | 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. |
| | `object` | 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). |
| | `object` | 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. |
| | `object` | 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`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | 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. |
| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `DELETE` | | 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`. |
-| | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `EXEC` | | 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`. |
+
+## `SELECT` examples
+
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+```sql
+SELECT
+name,
+done,
+error,
+metadata,
+response
+FROM google.alloydb.operations
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified operation resource.
+
+```sql
+DELETE FROM google.alloydb.operations
+WHERE locationsId = '{{ locationsId }}'
+AND operationsId = '{{ operationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/supported_database_flags/index.md b/docs/google-docs/providers/google/alloydb/supported_database_flags/index.md
index 463b79601d..6906a31e21 100644
--- a/docs/google-docs/providers/google/alloydb/supported_database_flags/index.md
+++ b/docs/google-docs/providers/google/alloydb/supported_database_flags/index.md
@@ -1,3 +1,4 @@
+
---
title: supported_database_flags
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- supported_database_flags
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an supported_database_flag
resource or lists supported_database_flags
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning. |
+| | `string` | The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning. |
| | `boolean` | Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified. |
| | `string` | The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field. |
| | `object` | Restrictions on INTEGER type values. |
@@ -38,8 +40,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Restrictions on STRING type values |
| | `array` | Major database engine versions for which this flag is supported. |
| | `string` | |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists SupportedDatabaseFlags for a given project and location. |
+
+## `SELECT` examples
+
+Lists SupportedDatabaseFlags for a given project and location.
+
+```sql
+SELECT
+name,
+acceptsMultipleValues,
+flagName,
+integerRestrictions,
+requiresDbRestart,
+stringRestrictions,
+supportedDbVersions,
+valueType
+FROM google.alloydb.supported_database_flags
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/alloydb/users/index.md b/docs/google-docs/providers/google/alloydb/users/index.md
index 64410658c1..d94f9868ee 100644
--- a/docs/google-docs/providers/google/alloydb/users/index.md
+++ b/docs/google-docs/providers/google/alloydb/users/index.md
@@ -1,3 +1,4 @@
+
---
title: users
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- users
- alloydb
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an user
resource or lists users
in a region
## Overview
@@ -30,10 +32,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
+| | `string` | Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. |
| | `array` | Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions. |
+| | `boolean` | Input only. If the user already exists and it has additional roles, keep them granted. |
| | `string` | Input only. Password for the user. |
| | `string` | Optional. Type of this user. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -42,4 +46,109 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new User in a given project, location, and cluster. |
| | `DELETE` | | Deletes a single User. |
| | `UPDATE` | | Updates the parameters of a single User. |
-| | `EXEC` | | Lists Users in a given project and location. |
+
+## `SELECT` examples
+
+Lists Users in a given project and location.
+
+```sql
+SELECT
+name,
+databaseRoles,
+keepExtraRoles,
+password,
+userType
+FROM google.alloydb.users
+WHERE clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new users
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.alloydb.users (
+clustersId,
+locationsId,
+projectsId,
+name,
+password,
+databaseRoles,
+userType,
+keepExtraRoles
+)
+SELECT
+'{{ clustersId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ password }}',
+'{{ databaseRoles }}',
+'{{ userType }}',
+true|false
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: password
+ value: '{{ password }}'
+ - name: databaseRoles
+ value: '{{ databaseRoles }}'
+ - name: userType
+ value: '{{ userType }}'
+ - name: keepExtraRoles
+ value: '{{ keepExtraRoles }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a user only if the necessary resources are available.
+
+```sql
+UPDATE google.alloydb.users
+SET
+name = '{{ name }}',
+password = '{{ password }}',
+databaseRoles = '{{ databaseRoles }}',
+userType = '{{ userType }}',
+keepExtraRoles = true|false
+WHERE
+clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND usersId = '{{ usersId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified user resource.
+
+```sql
+DELETE FROM google.alloydb.users
+WHERE clustersId = '{{ clustersId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND usersId = '{{ usersId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md
index d7a22571af..e8e451a3c7 100644
--- a/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md
+++ b/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md
@@ -1,3 +1,4 @@
+
---
title: data_exchanges
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data_exchanges
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an data_exchange
resource or lists data_exchanges
in a region
## Overview
@@ -32,12 +34,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. |
| | `string` | Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes. |
+| | `string` | Optional. Type of discovery on the discovery page for all the listings under this exchange. Updating this field also updates (overwrites) the discovery_type field for all the listings under this exchange. |
| | `string` | Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes. |
| | `string` | Optional. Documentation describing the data exchange. |
| | `string` | Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. |
| | `integer` | Output only. Number of listings contained in the data exchange. |
| | `string` | Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. |
| | `object` | Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -47,6 +51,129 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new data exchange. |
| | `DELETE` | | Deletes an existing data exchange. |
| | `UPDATE` | | Updates an existing data exchange. |
-| | `EXEC` | | Lists all data exchanges from projects in a given organization and location. |
-| | `EXEC` | | Lists all data exchanges in a given project and location. |
-| | `EXEC` | | Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets. |
+| | `EXEC` | | Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. |
+
+## `SELECT` examples
+
+Lists all data exchanges in a given project and location.
+
+```sql
+SELECT
+name,
+description,
+discoveryType,
+displayName,
+documentation,
+icon,
+listingCount,
+primaryContact,
+sharingEnvironmentConfig
+FROM google.analyticshub.data_exchanges
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new data_exchanges
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.analyticshub.data_exchanges (
+locationsId,
+projectsId,
+name,
+displayName,
+description,
+primaryContact,
+documentation,
+listingCount,
+icon,
+sharingEnvironmentConfig,
+discoveryType
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ description }}',
+'{{ primaryContact }}',
+'{{ documentation }}',
+'{{ listingCount }}',
+'{{ icon }}',
+'{{ sharingEnvironmentConfig }}',
+'{{ discoveryType }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: description
+ value: '{{ description }}'
+ - name: primaryContact
+ value: '{{ primaryContact }}'
+ - name: documentation
+ value: '{{ documentation }}'
+ - name: listingCount
+ value: '{{ listingCount }}'
+ - name: icon
+ value: '{{ icon }}'
+ - name: sharingEnvironmentConfig
+ value: '{{ sharingEnvironmentConfig }}'
+ - name: discoveryType
+ value: '{{ discoveryType }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a data_exchange only if the necessary resources are available.
+
+```sql
+UPDATE google.analyticshub.data_exchanges
+SET
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+description = '{{ description }}',
+primaryContact = '{{ primaryContact }}',
+documentation = '{{ documentation }}',
+listingCount = '{{ listingCount }}',
+icon = '{{ icon }}',
+sharingEnvironmentConfig = '{{ sharingEnvironmentConfig }}',
+discoveryType = '{{ discoveryType }}'
+WHERE
+dataExchangesId = '{{ dataExchangesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified data_exchange resource.
+
+```sql
+DELETE FROM google.analyticshub.data_exchanges
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md
index eb9dc4841a..5bca1aa54a 100644
--- a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md
+++ b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: data_exchanges_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data_exchanges_iam_policies
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an data_exchanges_iam_policy
resource or lists data_exchanges_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the IAM policy. |
-| | `EXEC` | | Gets the IAM policy. |
| | `EXEC` | | Sets the IAM policy. |
| | `EXEC` | | Returns the permissions that a caller has. |
+
+## `SELECT` examples
+
+Gets the IAM policy.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.analyticshub.data_exchanges_iam_policies
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md
index b53456412e..31d010e8bb 100644
--- a/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md
+++ b/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md
@@ -1,3 +1,4 @@
+
---
title: data_exchanges_subscriptions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data_exchanges_subscriptions
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an data_exchanges_subscription
resource or lists data_exchanges_subscriptions
in a region
## Overview
@@ -34,14 +36,40 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Timestamp when the subscription was created. |
| | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 |
| | `string` | Output only. Timestamp when the subscription was last modified. |
-| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `array` | Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. |
| | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 |
| | `string` | Output only. Display name of the project of this subscription. |
| | `string` | Output only. Organization of the project this subscription belongs to. |
+| | `string` | Output only. Listing shared asset type. |
| | `string` | Output only. Current state of the subscription. |
| | `string` | Output only. Email of the subscriber. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists all subscriptions on a given Data Exchange or Listing. |
+
+## `SELECT` examples
+
+Lists all subscriptions on a given Data Exchange or Listing.
+
+```sql
+SELECT
+name,
+creationTime,
+dataExchange,
+lastModifyTime,
+linkedDatasetMap,
+linkedResources,
+listing,
+organizationDisplayName,
+organizationId,
+resourceType,
+state,
+subscriberContact
+FROM google.analyticshub.data_exchanges_subscriptions
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/index.md b/docs/google-docs/providers/google/analyticshub/index.md
index c298ff93dc..fcd49d39d5 100644
--- a/docs/google-docs/providers/google/analyticshub/index.md
+++ b/docs/google-docs/providers/google/analyticshub/index.md
@@ -9,46 +9,35 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-Exchange data and analytics assets securely and efficiently.
-
+The analyticshub service documentation.
+
:::info Service Summary
total resources: 8
-total selectable resources: 8
-total methods: 37
:::
-## Overview
-
-Name | google.analyticshub |
-Type | Service |
-Title | Analytics Hub API |
-Description | Exchange data and analytics assets securely and efficiently. |
-Id | analyticshub:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/analyticshub/listings/index.md b/docs/google-docs/providers/google/analyticshub/listings/index.md
index b4666eb488..d2b1c0566f 100644
--- a/docs/google-docs/providers/google/analyticshub/listings/index.md
+++ b/docs/google-docs/providers/google/analyticshub/listings/index.md
@@ -1,3 +1,4 @@
+
---
title: listings
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- listings
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an listing
resource or lists listings
in a region
## Overview
@@ -35,14 +37,18 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. |
| | `array` | Optional. Categories of the listing. Up to two categories are allowed. |
| | `object` | Contains details of the data provider. |
+| | `string` | Optional. Type of discovery of the listing on the discovery page. |
| | `string` | Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. |
| | `string` | Optional. Documentation describing the listing. |
| | `string` | Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. |
| | `string` | Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. |
| | `object` | Contains details of the listing publisher. |
+| | `object` | Pub/Sub topic source. |
| | `string` | Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. |
+| | `string` | Output only. Listing shared asset type. |
| | `object` | Restricted export config, used to configure restricted export on linked dataset. |
| | `string` | Output only. Current state of the listing. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -51,5 +57,176 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new listing. |
| | `DELETE` | | Deletes a listing. |
| | `UPDATE` | | Updates an existing listing. |
-| | `EXEC` | | Lists all listings in a given project and location. |
| | `EXEC` | | Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project. |
+
+## `SELECT` examples
+
+Lists all listings in a given project and location.
+
+```sql
+SELECT
+name,
+description,
+bigqueryDataset,
+categories,
+dataProvider,
+discoveryType,
+displayName,
+documentation,
+icon,
+primaryContact,
+publisher,
+pubsubTopic,
+requestAccess,
+resourceType,
+restrictedExportConfig,
+state
+FROM google.analyticshub.listings
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new listings
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.analyticshub.listings (
+dataExchangesId,
+locationsId,
+projectsId,
+bigqueryDataset,
+pubsubTopic,
+name,
+displayName,
+description,
+primaryContact,
+documentation,
+state,
+icon,
+dataProvider,
+categories,
+publisher,
+requestAccess,
+restrictedExportConfig,
+discoveryType,
+resourceType
+)
+SELECT
+'{{ dataExchangesId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ bigqueryDataset }}',
+'{{ pubsubTopic }}',
+'{{ name }}',
+'{{ displayName }}',
+'{{ description }}',
+'{{ primaryContact }}',
+'{{ documentation }}',
+'{{ state }}',
+'{{ icon }}',
+'{{ dataProvider }}',
+'{{ categories }}',
+'{{ publisher }}',
+'{{ requestAccess }}',
+'{{ restrictedExportConfig }}',
+'{{ discoveryType }}',
+'{{ resourceType }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: bigqueryDataset
+ value: '{{ bigqueryDataset }}'
+ - name: pubsubTopic
+ value: '{{ pubsubTopic }}'
+ - name: name
+ value: '{{ name }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: description
+ value: '{{ description }}'
+ - name: primaryContact
+ value: '{{ primaryContact }}'
+ - name: documentation
+ value: '{{ documentation }}'
+ - name: state
+ value: '{{ state }}'
+ - name: icon
+ value: '{{ icon }}'
+ - name: dataProvider
+ value: '{{ dataProvider }}'
+ - name: categories
+ value: '{{ categories }}'
+ - name: publisher
+ value: '{{ publisher }}'
+ - name: requestAccess
+ value: '{{ requestAccess }}'
+ - name: restrictedExportConfig
+ value: '{{ restrictedExportConfig }}'
+ - name: discoveryType
+ value: '{{ discoveryType }}'
+ - name: resourceType
+ value: '{{ resourceType }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a listing only if the necessary resources are available.
+
+```sql
+UPDATE google.analyticshub.listings
+SET
+bigqueryDataset = '{{ bigqueryDataset }}',
+pubsubTopic = '{{ pubsubTopic }}',
+name = '{{ name }}',
+displayName = '{{ displayName }}',
+description = '{{ description }}',
+primaryContact = '{{ primaryContact }}',
+documentation = '{{ documentation }}',
+state = '{{ state }}',
+icon = '{{ icon }}',
+dataProvider = '{{ dataProvider }}',
+categories = '{{ categories }}',
+publisher = '{{ publisher }}',
+requestAccess = '{{ requestAccess }}',
+restrictedExportConfig = '{{ restrictedExportConfig }}',
+discoveryType = '{{ discoveryType }}',
+resourceType = '{{ resourceType }}'
+WHERE
+dataExchangesId = '{{ dataExchangesId }}'
+AND listingsId = '{{ listingsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified listing resource.
+
+```sql
+DELETE FROM google.analyticshub.listings
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND listingsId = '{{ listingsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md
index 7188a22238..b60ca69cb0 100644
--- a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md
+++ b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: listings_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- listings_iam_policies
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an listings_iam_policy
resource or lists listings_iam_policies
in a region
## Overview
@@ -30,13 +32,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the IAM policy. |
-| | `EXEC` | | Gets the IAM policy. |
| | `EXEC` | | Sets the IAM policy. |
| | `EXEC` | | Returns the permissions that a caller has. |
+
+## `SELECT` examples
+
+Gets the IAM policy.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.analyticshub.listings_iam_policies
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND listingsId = '{{ listingsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md
index 2e4a709cbc..e59e121dd1 100644
--- a/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md
+++ b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md
@@ -1,3 +1,4 @@
+
---
title: listings_subscriptions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- listings_subscriptions
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an listings_subscription
resource or lists listings_subscriptions
in a region
## Overview
@@ -34,14 +36,41 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Timestamp when the subscription was created. |
| | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 |
| | `string` | Output only. Timestamp when the subscription was last modified. |
-| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `array` | Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. |
| | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 |
| | `string` | Output only. Display name of the project of this subscription. |
| | `string` | Output only. Organization of the project this subscription belongs to. |
+| | `string` | Output only. Listing shared asset type. |
| | `string` | Output only. Current state of the subscription. |
| | `string` | Output only. Email of the subscriber. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Lists all subscriptions on a given Data Exchange or Listing. |
+
+## `SELECT` examples
+
+Lists all subscriptions on a given Data Exchange or Listing.
+
+```sql
+SELECT
+name,
+creationTime,
+dataExchange,
+lastModifyTime,
+linkedDatasetMap,
+linkedResources,
+listing,
+organizationDisplayName,
+organizationId,
+resourceType,
+state,
+subscriberContact
+FROM google.analyticshub.listings_subscriptions
+WHERE dataExchangesId = '{{ dataExchangesId }}'
+AND listingsId = '{{ listingsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md
index 7c6a2751b0..a017e34aa2 100644
--- a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md
+++ b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md
@@ -1,3 +1,4 @@
+
---
title: subscriptions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- subscriptions
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an subscription
resource or lists subscriptions
in a region
## Overview
@@ -34,18 +36,54 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Timestamp when the subscription was created. |
| | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 |
| | `string` | Output only. Timestamp when the subscription was last modified. |
-| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. |
+| | `array` | Output only. Linked resources created in the subscription. Only contains values if state = STATE_ACTIVE. |
| | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 |
| | `string` | Output only. Display name of the project of this subscription. |
| | `string` | Output only. Organization of the project this subscription belongs to. |
+| | `string` | Output only. Listing shared asset type. |
| | `string` | Output only. Current state of the subscription. |
| | `string` | Output only. Email of the subscriber. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the details of a Subscription. |
| | `SELECT` | | Lists all subscriptions in a given project and location. |
| | `DELETE` | | Deletes a subscription. |
-| | `EXEC` | | Lists all subscriptions in a given project and location. |
| | `EXEC` | | Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets. |
| | `EXEC` | | Revokes a given subscription. |
+
+## `SELECT` examples
+
+Lists all subscriptions in a given project and location.
+
+```sql
+SELECT
+name,
+creationTime,
+dataExchange,
+lastModifyTime,
+linkedDatasetMap,
+linkedResources,
+listing,
+organizationDisplayName,
+organizationId,
+resourceType,
+state,
+subscriberContact
+FROM google.analyticshub.subscriptions
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified subscription resource.
+
+```sql
+DELETE FROM google.analyticshub.subscriptions
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND subscriptionsId = '{{ subscriptionsId }}';
+```
diff --git a/docs/google-docs/providers/google/analyticshub/subscriptions_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/subscriptions_iam_policies/index.md
index 331fc0e58e..84aad3a4d3 100644
--- a/docs/google-docs/providers/google/analyticshub/subscriptions_iam_policies/index.md
+++ b/docs/google-docs/providers/google/analyticshub/subscriptions_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: subscriptions_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- subscriptions_iam_policies
- analyticshub
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an subscriptions_iam_policy
resource or lists subscriptions_iam_policies
in a region
## Overview
@@ -30,12 +32,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the IAM policy. |
-| | `EXEC` | | Gets the IAM policy. |
| | `EXEC` | | Sets the IAM policy. |
+
+## `SELECT` examples
+
+Gets the IAM policy.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.analyticshub.subscriptions_iam_policies
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}'
+AND subscriptionsId = '{{ subscriptionsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/apis/index.md b/docs/google-docs/providers/google/apigateway/apis/index.md
index 606c14ea1c..f16d63443b 100644
--- a/docs/google-docs/providers/google/apigateway/apis/index.md
+++ b/docs/google-docs/providers/google/apigateway/apis/index.md
@@ -1,3 +1,4 @@
+
---
title: apis
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apis
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an api
resource or lists apis
in a region
## Overview
@@ -30,13 +32,14 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api} |
+| | `string` | Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api} |
| | `string` | Output only. Created time. |
| | `string` | Optional. Display name. |
| | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| | `string` | Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. |
| | `string` | Output only. State of the API. |
| | `string` | Output only. Updated time. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -45,4 +48,116 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Api in a given project and location. |
| | `DELETE` | | Deletes a single Api. |
| | `UPDATE` | | Updates the parameters of a single Api. |
-| | `EXEC` | | Lists Apis in a given project and location. |
+
+## `SELECT` examples
+
+Lists Apis in a given project and location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+labels,
+managedService,
+state,
+updateTime
+FROM google.apigateway.apis
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apis
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigateway.apis (
+locationsId,
+projectsId,
+name,
+createTime,
+updateTime,
+labels,
+displayName,
+managedService,
+state
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ displayName }}',
+'{{ managedService }}',
+'{{ state }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: managedService
+ value: '{{ managedService }}'
+ - name: state
+ value: '{{ state }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a api only if the necessary resources are available.
+
+```sql
+UPDATE google.apigateway.apis
+SET
+name = '{{ name }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+labels = '{{ labels }}',
+displayName = '{{ displayName }}',
+managedService = '{{ managedService }}',
+state = '{{ state }}'
+WHERE
+apisId = '{{ apisId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified api resource.
+
+```sql
+DELETE FROM google.apigateway.apis
+WHERE apisId = '{{ apisId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md
index 3f3f309c4c..740158f822 100644
--- a/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md
+++ b/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: apis_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apis_iam_policies
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apis_iam_policy
resource or lists apis_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.apigateway.apis_iam_policies
+WHERE apisId = '{{ apisId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/configs/index.md b/docs/google-docs/providers/google/apigateway/configs/index.md
index 592400c7d7..25bacc2bf2 100644
--- a/docs/google-docs/providers/google/apigateway/configs/index.md
+++ b/docs/google-docs/providers/google/apigateway/configs/index.md
@@ -1,3 +1,4 @@
+
---
title: configs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- configs
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an config
resource or lists configs
in a region
## Overview
@@ -30,10 +32,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} |
+| | `string` | Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} |
| | `string` | Output only. Created time. |
| | `string` | Optional. Display name. |
-| | `string` | Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service. |
+| | `string` | Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service. |
| | `array` | Optional. gRPC service definition files. If specified, openapi_documents must not be included. |
| | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| | `array` | Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. |
@@ -41,6 +43,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config). |
| | `string` | Output only. State of the API Config. |
| | `string` | Output only. Updated time. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -49,4 +52,145 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new ApiConfig in a given project and location. |
| | `DELETE` | | Deletes a single ApiConfig. |
| | `UPDATE` | | Updates the parameters of a single ApiConfig. |
-| | `EXEC` | | Lists ApiConfigs in a given project and location. |
+
+## `SELECT` examples
+
+Lists ApiConfigs in a given project and location.
+
+```sql
+SELECT
+name,
+createTime,
+displayName,
+gatewayServiceAccount,
+grpcServices,
+labels,
+managedServiceConfigs,
+openapiDocuments,
+serviceConfigId,
+state,
+updateTime
+FROM google.apigateway.configs
+WHERE apisId = '{{ apisId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new configs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigateway.configs (
+apisId,
+locationsId,
+projectsId,
+name,
+createTime,
+updateTime,
+labels,
+displayName,
+gatewayServiceAccount,
+serviceConfigId,
+state,
+openapiDocuments,
+grpcServices,
+managedServiceConfigs
+)
+SELECT
+'{{ apisId }}',
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ displayName }}',
+'{{ gatewayServiceAccount }}',
+'{{ serviceConfigId }}',
+'{{ state }}',
+'{{ openapiDocuments }}',
+'{{ grpcServices }}',
+'{{ managedServiceConfigs }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: gatewayServiceAccount
+ value: '{{ gatewayServiceAccount }}'
+ - name: serviceConfigId
+ value: '{{ serviceConfigId }}'
+ - name: state
+ value: '{{ state }}'
+ - name: openapiDocuments
+ value: '{{ openapiDocuments }}'
+ - name: grpcServices
+ value: '{{ grpcServices }}'
+ - name: managedServiceConfigs
+ value: '{{ managedServiceConfigs }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a config only if the necessary resources are available.
+
+```sql
+UPDATE google.apigateway.configs
+SET
+name = '{{ name }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+labels = '{{ labels }}',
+displayName = '{{ displayName }}',
+gatewayServiceAccount = '{{ gatewayServiceAccount }}',
+serviceConfigId = '{{ serviceConfigId }}',
+state = '{{ state }}',
+openapiDocuments = '{{ openapiDocuments }}',
+grpcServices = '{{ grpcServices }}',
+managedServiceConfigs = '{{ managedServiceConfigs }}'
+WHERE
+apisId = '{{ apisId }}'
+AND configsId = '{{ configsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified config resource.
+
+```sql
+DELETE FROM google.apigateway.configs
+WHERE apisId = '{{ apisId }}'
+AND configsId = '{{ configsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md
index 8c96d40d1e..67bd06e404 100644
--- a/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md
+++ b/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: configs_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- configs_iam_policies
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an configs_iam_policy
resource or lists configs_iam_policies
in a region
## Overview
@@ -30,13 +32,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.apigateway.configs_iam_policies
+WHERE apisId = '{{ apisId }}'
+AND configsId = '{{ configsId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/gateways/index.md b/docs/google-docs/providers/google/apigateway/gateways/index.md
index 9aba63ff06..26259fd35c 100644
--- a/docs/google-docs/providers/google/apigateway/gateways/index.md
+++ b/docs/google-docs/providers/google/apigateway/gateways/index.md
@@ -1,3 +1,4 @@
+
---
title: gateways
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- gateways
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an gateway
resource or lists gateways
in a region
## Overview
@@ -30,14 +32,15 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} |
-| | `string` | Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} |
+| | `string` | Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} |
+| | `string` | Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} |
| | `string` | Output only. Created time. |
-| | `string` | Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. |
+| | `string` | Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. |
| | `string` | Optional. Display name. |
| | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| | `string` | Output only. The current state of the Gateway. |
| | `string` | Output only. Updated time. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -46,4 +49,122 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new Gateway in a given project and location. |
| | `DELETE` | | Deletes a single Gateway. |
| | `UPDATE` | | Updates the parameters of a single Gateway. |
-| | `EXEC` | | Lists Gateways in a given project and location. |
+
+## `SELECT` examples
+
+Lists Gateways in a given project and location.
+
+```sql
+SELECT
+name,
+apiConfig,
+createTime,
+defaultHostname,
+displayName,
+labels,
+state,
+updateTime
+FROM google.apigateway.gateways
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new gateways
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigateway.gateways (
+locationsId,
+projectsId,
+name,
+createTime,
+updateTime,
+labels,
+displayName,
+apiConfig,
+state,
+defaultHostname
+)
+SELECT
+'{{ locationsId }}',
+'{{ projectsId }}',
+'{{ name }}',
+'{{ createTime }}',
+'{{ updateTime }}',
+'{{ labels }}',
+'{{ displayName }}',
+'{{ apiConfig }}',
+'{{ state }}',
+'{{ defaultHostname }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+ - name: labels
+ value: '{{ labels }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: apiConfig
+ value: '{{ apiConfig }}'
+ - name: state
+ value: '{{ state }}'
+ - name: defaultHostname
+ value: '{{ defaultHostname }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a gateway only if the necessary resources are available.
+
+```sql
+UPDATE google.apigateway.gateways
+SET
+name = '{{ name }}',
+createTime = '{{ createTime }}',
+updateTime = '{{ updateTime }}',
+labels = '{{ labels }}',
+displayName = '{{ displayName }}',
+apiConfig = '{{ apiConfig }}',
+state = '{{ state }}',
+defaultHostname = '{{ defaultHostname }}'
+WHERE
+gatewaysId = '{{ gatewaysId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified gateway resource.
+
+```sql
+DELETE FROM google.apigateway.gateways
+WHERE gatewaysId = '{{ gatewaysId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md
index 7fe3df2052..b61c1824dc 100644
--- a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md
+++ b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: gateways_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- gateways_iam_policies
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an gateways_iam_policy
resource or lists gateways_iam_policies
in a region
## Overview
@@ -30,13 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
-| | `EXEC` | | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. |
| | `EXEC` | | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| | `EXEC` | | 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. |
+
+## `SELECT` examples
+
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.apigateway.gateways_iam_policies
+WHERE gatewaysId = '{{ gatewaysId }}'
+AND locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/index.md b/docs/google-docs/providers/google/apigateway/index.md
index 8a016dc8a1..ef856eb342 100644
--- a/docs/google-docs/providers/google/apigateway/index.md
+++ b/docs/google-docs/providers/google/apigateway/index.md
@@ -9,46 +9,35 @@ keywords:
- infrastructure-as-code
- configuration-as-data
- cloud inventory
-description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+description: Query, deploy and manage google resources using SQL
custom_edit_url: null
image: /img/providers/google/stackql-google-provider-featured-image.png
---
-
-
+The apigateway service documentation.
+
:::info Service Summary
total resources: 8
-total selectable resources: 8
-total methods: 38
:::
-## Overview
-
-Name | google.apigateway |
-Type | Service |
-Title | API Gateway API |
-Description | |
-Id | apigateway:v24.06.00236 |
-
-
## Resources
+
\ No newline at end of file
diff --git a/docs/google-docs/providers/google/apigateway/locations/index.md b/docs/google-docs/providers/google/apigateway/locations/index.md
index f12c7f32dc..b570e87edb 100644
--- a/docs/google-docs/providers/google/apigateway/locations/index.md
+++ b/docs/google-docs/providers/google/apigateway/locations/index.md
@@ -1,3 +1,4 @@
+
---
title: locations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- locations
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an location
resource or lists locations
in a region
## Overview
@@ -32,12 +34,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` |
| | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". |
-| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
+| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} |
| | `string` | The canonical id for this location. For example: `"us-east1"`. |
| | `object` | Service-specific metadata. For example the available capacity at the given location. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets information about a location. |
| | `SELECT` | | Lists information about the supported locations for this service. |
-| | `EXEC` | | Lists information about the supported locations for this service. |
+
+## `SELECT` examples
+
+Lists information about the supported locations for this service.
+
+```sql
+SELECT
+name,
+displayName,
+labels,
+locationId,
+metadata
+FROM google.apigateway.locations
+WHERE projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigateway/operations/index.md b/docs/google-docs/providers/google/apigateway/operations/index.md
index 2d38b2d7fc..77c29233e9 100644
--- a/docs/google-docs/providers/google/apigateway/operations/index.md
+++ b/docs/google-docs/providers/google/apigateway/operations/index.md
@@ -1,3 +1,4 @@
+
---
title: operations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- operations
- apigateway
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an operation
resource or lists operations
in a region
## Overview
@@ -30,16 +32,43 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `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}`. |
+| | `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}`. |
| | `boolean` | 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. |
| | `object` | 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). |
| | `object` | 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. |
| | `object` | 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`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | 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. |
| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `DELETE` | | 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`. |
-| | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| | `EXEC` | | 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`. |
+
+## `SELECT` examples
+
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+```sql
+SELECT
+name,
+done,
+error,
+metadata,
+response
+FROM google.apigateway.operations
+WHERE locationsId = '{{ locationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified operation resource.
+
+```sql
+DELETE FROM google.apigateway.operations
+WHERE locationsId = '{{ locationsId }}'
+AND operationsId = '{{ operationsId }}'
+AND projectsId = '{{ projectsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/addons_config/index.md b/docs/google-docs/providers/google/apigee/addons_config/index.md
index 3461a9e6a1..15c13dae72 100644
--- a/docs/google-docs/providers/google/apigee/addons_config/index.md
+++ b/docs/google-docs/providers/google/apigee/addons_config/index.md
@@ -1,3 +1,4 @@
+
---
title: addons_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- addons_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an addons_config
resource or lists addons_config
in a region
## Overview
@@ -28,8 +30,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `EXEC` | | Updates an add-on enablement status of an environment. |
diff --git a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md
index b0888b4e1a..aac9bd87c3 100644
--- a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md
+++ b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md
@@ -1,3 +1,4 @@
+
---
title: admin_schemav2
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- admin_schemav2
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an admin_schemav2
resource or lists admin_schemav2
in a region
## Overview
@@ -33,7 +35,22 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | List of schema fields grouped as dimensions. |
| | `array` | Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings. |
| | `array` | List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field. |
+
+## `SELECT` examples
+
+Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.
+
+```sql
+SELECT
+dimensions,
+meta,
+metrics
+FROM google.apigee.admin_schemav2
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/aliases/index.md b/docs/google-docs/providers/google/apigee/aliases/index.md
index 93163e6493..7433e46a93 100644
--- a/docs/google-docs/providers/google/apigee/aliases/index.md
+++ b/docs/google-docs/providers/google/apigee/aliases/index.md
@@ -1,3 +1,4 @@
+
---
title: aliases
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- aliases
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an alias
resource or lists aliases
in a region
## Overview
@@ -30,14 +32,93 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. |
+| | `string` | Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. |
| | `object` | |
| | `string` | Type of alias. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets an alias. |
| | `INSERT` | | Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body. |
| | `DELETE` | | Deletes an alias. |
-| | `UPDATE` | | Updates the certificate in an alias. |
| | `EXEC` | | Generates a PKCS #10 Certificate Signing Request for the private key in an alias. |
+| | `EXEC` | | Updates the certificate in an alias. |
+
+## `SELECT` examples
+
+Gets an alias.
+
+```sql
+SELECT
+alias,
+certsInfo,
+type
+FROM google.apigee.aliases
+WHERE aliasesId = '{{ aliasesId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND keystoresId = '{{ keystoresId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new aliases
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.aliases (
+environmentsId,
+keystoresId,
+organizationsId,
+contentType,
+extensions,
+data
+)
+SELECT
+'{{ environmentsId }}',
+'{{ keystoresId }}',
+'{{ organizationsId }}',
+'{{ contentType }}',
+'{{ extensions }}',
+'{{ data }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: contentType
+ value: '{{ contentType }}'
+ - name: extensions
+ value: '{{ extensions }}'
+ - name: data
+ value: '{{ data }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified alias resource.
+
+```sql
+DELETE FROM google.apigee.aliases
+WHERE aliasesId = '{{ aliasesId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND keystoresId = '{{ keystoresId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/aliases_certificate/index.md b/docs/google-docs/providers/google/apigee/aliases_certificate/index.md
index 9ec3646cc9..634528b164 100644
--- a/docs/google-docs/providers/google/apigee/aliases_certificate/index.md
+++ b/docs/google-docs/providers/google/apigee/aliases_certificate/index.md
@@ -1,3 +1,4 @@
+
---
title: aliases_certificate
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- aliases_certificate
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an aliases_certificate
resource or lists aliases_certificate
in a region
## Overview
@@ -33,7 +35,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | The HTTP Content-Type header value specifying the content type of the body. |
| | `string` | The HTTP request/response body as raw binary. |
| | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the certificate from an alias in PEM-encoded form. |
+
+## `SELECT` examples
+
+Gets the certificate from an alias in PEM-encoded form.
+
+```sql
+SELECT
+contentType,
+data,
+extensions
+FROM google.apigee.aliases_certificate
+WHERE aliasesId = '{{ aliasesId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND keystoresId = '{{ keystoresId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apicategories/index.md b/docs/google-docs/providers/google/apigee/apicategories/index.md
index 1f50640c99..a62a5bbc27 100644
--- a/docs/google-docs/providers/google/apigee/apicategories/index.md
+++ b/docs/google-docs/providers/google/apigee/apicategories/index.md
@@ -1,3 +1,4 @@
+
---
title: apicategories
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apicategories
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apicategory
resource or lists apicategories
in a region
## Overview
@@ -35,6 +37,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Description of the operation. |
| | `string` | Unique ID of the request. |
| | `string` | Status of the operation. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,3 +46,99 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new API category. |
| | `DELETE` | | Deletes an API category. |
| | `UPDATE` | | Updates an API category. |
+
+## `SELECT` examples
+
+Returns the API categories associated with a portal.
+
+```sql
+SELECT
+data,
+errorCode,
+message,
+requestId,
+status
+FROM google.apigee.apicategories
+WHERE organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apicategories
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.apicategories (
+organizationsId,
+sitesId,
+siteId,
+id,
+name,
+updateTime
+)
+SELECT
+'{{ organizationsId }}',
+'{{ sitesId }}',
+'{{ siteId }}',
+'{{ id }}',
+'{{ name }}',
+'{{ updateTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: siteId
+ value: '{{ siteId }}'
+ - name: id
+ value: '{{ id }}'
+ - name: name
+ value: '{{ name }}'
+ - name: updateTime
+ value: '{{ updateTime }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a apicategory only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.apicategories
+SET
+siteId = '{{ siteId }}',
+id = '{{ id }}',
+name = '{{ name }}',
+updateTime = '{{ updateTime }}'
+WHERE
+apicategoriesId = '{{ apicategoriesId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified apicategory resource.
+
+```sql
+DELETE FROM google.apigee.apicategories
+WHERE apicategoriesId = '{{ apicategoriesId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apidocs/index.md b/docs/google-docs/providers/google/apigee/apidocs/index.md
index 563046d434..2168471df2 100644
--- a/docs/google-docs/providers/google/apigee/apidocs/index.md
+++ b/docs/google-docs/providers/google/apigee/apidocs/index.md
@@ -1,3 +1,4 @@
+
---
title: apidocs
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apidocs
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apidoc
resource or lists apidocs
in a region
## Overview
@@ -35,6 +37,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Description of the operation. |
| | `string` | Unique ID of the request. |
| | `string` | Status of the operation. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -42,5 +45,135 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Returns the catalog items associated with a portal. |
| | `INSERT` | | Creates a new catalog item. |
| | `DELETE` | | Deletes a catalog item. |
-| | `UPDATE` | | Updates a catalog item. |
-| | `EXEC` | | Returns the catalog items associated with a portal. |
+| | `EXEC` | | Updates a catalog item. |
+
+## `SELECT` examples
+
+Returns the catalog items associated with a portal.
+
+```sql
+SELECT
+data,
+errorCode,
+message,
+requestId,
+status
+FROM google.apigee.apidocs
+WHERE organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apidocs
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.apidocs (
+organizationsId,
+sitesId,
+graphqlEndpointUrl,
+anonAllowed,
+apiProductName,
+requireCallbackUrl,
+siteId,
+title,
+description,
+graphqlSchema,
+modified,
+graphqlSchemaDisplayName,
+published,
+id,
+imageUrl,
+specId,
+visibility,
+edgeAPIProductName,
+categoryIds
+)
+SELECT
+'{{ organizationsId }}',
+'{{ sitesId }}',
+'{{ graphqlEndpointUrl }}',
+true|false,
+'{{ apiProductName }}',
+true|false,
+'{{ siteId }}',
+'{{ title }}',
+'{{ description }}',
+'{{ graphqlSchema }}',
+'{{ modified }}',
+'{{ graphqlSchemaDisplayName }}',
+true|false,
+'{{ id }}',
+'{{ imageUrl }}',
+'{{ specId }}',
+true|false,
+'{{ edgeAPIProductName }}',
+'{{ categoryIds }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: graphqlEndpointUrl
+ value: '{{ graphqlEndpointUrl }}'
+ - name: anonAllowed
+ value: '{{ anonAllowed }}'
+ - name: apiProductName
+ value: '{{ apiProductName }}'
+ - name: requireCallbackUrl
+ value: '{{ requireCallbackUrl }}'
+ - name: siteId
+ value: '{{ siteId }}'
+ - name: title
+ value: '{{ title }}'
+ - name: description
+ value: '{{ description }}'
+ - name: graphqlSchema
+ value: '{{ graphqlSchema }}'
+ - name: modified
+ value: '{{ modified }}'
+ - name: graphqlSchemaDisplayName
+ value: '{{ graphqlSchemaDisplayName }}'
+ - name: published
+ value: '{{ published }}'
+ - name: id
+ value: '{{ id }}'
+ - name: imageUrl
+ value: '{{ imageUrl }}'
+ - name: specId
+ value: '{{ specId }}'
+ - name: visibility
+ value: '{{ visibility }}'
+ - name: edgeAPIProductName
+ value: '{{ edgeAPIProductName }}'
+ - name: categoryIds
+ value: '{{ categoryIds }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified apidoc resource.
+
+```sql
+DELETE FROM google.apigee.apidocs
+WHERE apidocsId = '{{ apidocsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apidocs_documentation/index.md b/docs/google-docs/providers/google/apigee/apidocs_documentation/index.md
index 54027615d9..6d4d440838 100644
--- a/docs/google-docs/providers/google/apigee/apidocs_documentation/index.md
+++ b/docs/google-docs/providers/google/apigee/apidocs_documentation/index.md
@@ -1,3 +1,4 @@
+
---
title: apidocs_documentation
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apidocs_documentation
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apidocs_documentation
resource or lists apidocs_documentation
in a region
## Overview
@@ -35,8 +37,41 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Description of the operation. |
| | `string` | Output only. Unique ID of the request. |
| | `string` | Output only. Status of the operation. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the documentation for the specified catalog item. |
-| | `EXEC` | | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
+| | `UPDATE` | | Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message. |
+
+## `SELECT` examples
+
+Gets the documentation for the specified catalog item.
+
+```sql
+SELECT
+data,
+errorCode,
+message,
+requestId,
+status
+FROM google.apigee.apidocs_documentation
+WHERE apidocsId = '{{ apidocsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
+
+## `UPDATE` example
+
+Updates a apidocs_documentation only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.apidocs_documentation
+SET
+graphqlDocumentation = '{{ graphqlDocumentation }}',
+oasDocumentation = '{{ oasDocumentation }}'
+WHERE
+apidocsId = '{{ apidocsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND sitesId = '{{ sitesId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apiproducts/index.md b/docs/google-docs/providers/google/apigee/apiproducts/index.md
index 5edc4ce07c..c527093688 100644
--- a/docs/google-docs/providers/google/apigee/apiproducts/index.md
+++ b/docs/google-docs/providers/google/apigee/apiproducts/index.md
@@ -1,3 +1,4 @@
+
---
title: apiproducts
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apiproducts
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apiproduct
resource or lists apiproducts
in a region
## Overview
@@ -48,6 +50,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Time interval over which the number of request messages is calculated. |
| | `string` | Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. |
| | `array` | Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -57,5 +60,149 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `DELETE` | | Deletes an API product from an organization. Deleting an API product causes app requests to the resource URIs defined in the API product to fail. Ensure that you create a new API product to serve existing apps, unless your intention is to disable access to the resources defined in the API product. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via the UI or the API. View the list of API products to verify the internal name. |
| | `DELETE` | | Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product. |
| | `DELETE` | | Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product. |
-| | `UPDATE` | | Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names. |
| | `EXEC` | | Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
+| | `EXEC` | | Updates an existing API product. You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. The API product name required in the request URL is the internal name of the product, not the display name. While they may be the same, it depends on whether the API product was created via UI or API. View the list of API products to identify their internal names. |
+
+## `SELECT` examples
+
+Lists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
+
+```sql
+SELECT
+name,
+description,
+apiResources,
+approvalType,
+attributes,
+createdAt,
+displayName,
+environments,
+graphqlOperationGroup,
+grpcOperationGroup,
+lastModifiedAt,
+operationGroup,
+proxies,
+quota,
+quotaCounterScope,
+quotaInterval,
+quotaTimeUnit,
+scopes
+FROM google.apigee.apiproducts
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apiproducts
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.apiproducts (
+organizationsId,
+displayName,
+scopes,
+apiResources,
+quotaInterval,
+proxies,
+createdAt,
+approvalType,
+name,
+attributes,
+grpcOperationGroup,
+quotaTimeUnit,
+description,
+quota,
+lastModifiedAt,
+environments,
+graphqlOperationGroup,
+operationGroup,
+quotaCounterScope
+)
+SELECT
+'{{ organizationsId }}',
+'{{ displayName }}',
+'{{ scopes }}',
+'{{ apiResources }}',
+'{{ quotaInterval }}',
+'{{ proxies }}',
+'{{ createdAt }}',
+'{{ approvalType }}',
+'{{ name }}',
+'{{ attributes }}',
+'{{ grpcOperationGroup }}',
+'{{ quotaTimeUnit }}',
+'{{ description }}',
+'{{ quota }}',
+'{{ lastModifiedAt }}',
+'{{ environments }}',
+'{{ graphqlOperationGroup }}',
+'{{ operationGroup }}',
+'{{ quotaCounterScope }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: scopes
+ value: '{{ scopes }}'
+ - name: apiResources
+ value: '{{ apiResources }}'
+ - name: quotaInterval
+ value: '{{ quotaInterval }}'
+ - name: proxies
+ value: '{{ proxies }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: approvalType
+ value: '{{ approvalType }}'
+ - name: name
+ value: '{{ name }}'
+ - name: attributes
+ value: '{{ attributes }}'
+ - name: grpcOperationGroup
+ value: '{{ grpcOperationGroup }}'
+ - name: quotaTimeUnit
+ value: '{{ quotaTimeUnit }}'
+ - name: description
+ value: '{{ description }}'
+ - name: quota
+ value: '{{ quota }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: environments
+ value: '{{ environments }}'
+ - name: graphqlOperationGroup
+ value: '{{ graphqlOperationGroup }}'
+ - name: operationGroup
+ value: '{{ operationGroup }}'
+ - name: quotaCounterScope
+ value: '{{ quotaCounterScope }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified apiproduct resource.
+
+```sql
+DELETE FROM google.apigee.apiproducts
+WHERE apiproductsId = '{{ apiproductsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apiproducts_app_group_app_key_api_product/index.md b/docs/google-docs/providers/google/apigee/apiproducts_app_group_app_key_api_product/index.md
index 81b4274817..efb64d95f8 100644
--- a/docs/google-docs/providers/google/apigee/apiproducts_app_group_app_key_api_product/index.md
+++ b/docs/google-docs/providers/google/apigee/apiproducts_app_group_app_key_api_product/index.md
@@ -1,3 +1,4 @@
+
---
title: apiproducts_app_group_app_key_api_product
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apiproducts_app_group_app_key_api_product
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apiproducts_app_group_app_key_api_product
resource or lists apiproducts_app_group_app_key_api_product
in a region
## Overview
@@ -28,8 +30,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to `revoked` will not allow access to the API. |
+
+## `UPDATE` example
+
+Updates a apiproducts_app_group_app_key_api_product only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.apiproducts_app_group_app_key_api_product
+SET
+
+WHERE
+apiproductsId = '{{ apiproductsId }}'
+AND appgroupsId = '{{ appgroupsId }}'
+AND appsId = '{{ appsId }}'
+AND keysId = '{{ keysId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apiproducts_developer_app_key_api_product/index.md b/docs/google-docs/providers/google/apigee/apiproducts_developer_app_key_api_product/index.md
index 10e38a10a8..902b87c295 100644
--- a/docs/google-docs/providers/google/apigee/apiproducts_developer_app_key_api_product/index.md
+++ b/docs/google-docs/providers/google/apigee/apiproducts_developer_app_key_api_product/index.md
@@ -1,3 +1,4 @@
+
---
title: apiproducts_developer_app_key_api_product
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apiproducts_developer_app_key_api_product
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an apiproducts_developer_app_key_api_product
resource or lists apiproducts_developer_app_key_api_product
in a region
## Overview
@@ -28,8 +30,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to `revoked` will not allow access to the API. |
+
+## `UPDATE` example
+
+Updates a apiproducts_developer_app_key_api_product only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.apiproducts_developer_app_key_api_product
+SET
+
+WHERE
+apiproductsId = '{{ apiproductsId }}'
+AND appsId = '{{ appsId }}'
+AND developersId = '{{ developersId }}'
+AND keysId = '{{ keysId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apis/index.md b/docs/google-docs/providers/google/apigee/apis/index.md
index e075377e76..eb6c0daf47 100644
--- a/docs/google-docs/providers/google/apigee/apis/index.md
+++ b/docs/google-docs/providers/google/apigee/apis/index.md
@@ -1,3 +1,4 @@
+
---
title: apis
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apis
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an api
resource or lists apis
in a region
## Overview
@@ -37,6 +39,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Metadata common to many entities in this API. |
| | `boolean` | Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive. |
| | `array` | Output only. List of revisions defined for the API proxy. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -45,3 +48,95 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client. |
| | `DELETE` | | Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it. |
| | `UPDATE` | | Updates an existing API proxy. |
+
+## `SELECT` examples
+
+Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
+
+```sql
+SELECT
+name,
+apiProxyType,
+labels,
+latestRevisionId,
+metaData,
+readOnly,
+revision
+FROM google.apigee.apis
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apis
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.apis (
+organizationsId,
+contentType,
+extensions,
+data
+)
+SELECT
+'{{ organizationsId }}',
+'{{ contentType }}',
+'{{ extensions }}',
+'{{ data }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: contentType
+ value: '{{ contentType }}'
+ - name: extensions
+ value: '{{ extensions }}'
+ - name: data
+ value: '{{ data }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a api only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.apis
+SET
+labels = '{{ labels }}',
+apiProxyType = '{{ apiProxyType }}',
+latestRevisionId = '{{ latestRevisionId }}',
+readOnly = true|false,
+name = '{{ name }}',
+metaData = '{{ metaData }}',
+revision = '{{ revision }}'
+WHERE
+apisId = '{{ apisId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified api resource.
+
+```sql
+DELETE FROM google.apigee.apis
+WHERE apisId = '{{ apisId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/appgroups/index.md b/docs/google-docs/providers/google/apigee/appgroups/index.md
index b935b8e8c7..b530b4ff9f 100644
--- a/docs/google-docs/providers/google/apigee/appgroups/index.md
+++ b/docs/google-docs/providers/google/apigee/appgroups/index.md
@@ -1,3 +1,4 @@
+
---
title: appgroups
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- appgroups
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an appgroup
resource or lists appgroups
in a region
## Overview
@@ -40,6 +42,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Modified time as milliseconds since epoch. |
| | `string` | Immutable. the org the app group is created |
| | `string` | Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -47,5 +50,108 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. |
| | `INSERT` | | Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`. |
| | `DELETE` | | Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted. |
-| | `UPDATE` | | Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. |
-| | `EXEC` | | Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. |
+| | `EXEC` | | Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. |
+
+## `SELECT` examples
+
+Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
+
+```sql
+SELECT
+name,
+appGroupId,
+attributes,
+channelId,
+channelUri,
+createdAt,
+displayName,
+lastModifiedAt,
+organization,
+status
+FROM google.apigee.appgroups
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new appgroups
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.appgroups (
+organizationsId,
+appGroupId,
+organization,
+channelId,
+status,
+attributes,
+name,
+channelUri,
+lastModifiedAt,
+displayName,
+createdAt
+)
+SELECT
+'{{ organizationsId }}',
+'{{ appGroupId }}',
+'{{ organization }}',
+'{{ channelId }}',
+'{{ status }}',
+'{{ attributes }}',
+'{{ name }}',
+'{{ channelUri }}',
+'{{ lastModifiedAt }}',
+'{{ displayName }}',
+'{{ createdAt }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: appGroupId
+ value: '{{ appGroupId }}'
+ - name: organization
+ value: '{{ organization }}'
+ - name: channelId
+ value: '{{ channelId }}'
+ - name: status
+ value: '{{ status }}'
+ - name: attributes
+ value: '{{ attributes }}'
+ - name: name
+ value: '{{ name }}'
+ - name: channelUri
+ value: '{{ channelUri }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified appgroup resource.
+
+```sql
+DELETE FROM google.apigee.appgroups
+WHERE appgroupsId = '{{ appgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/apps/index.md b/docs/google-docs/providers/google/apigee/apps/index.md
index ab1813cf9f..19df84f030 100644
--- a/docs/google-docs/providers/google/apigee/apps/index.md
+++ b/docs/google-docs/providers/google/apigee/apps/index.md
@@ -1,3 +1,4 @@
+
---
title: apps
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- apps
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an app
resource or lists apps
in a region
## Overview
@@ -30,19 +32,19 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the developer app. |
-| | `array` | List of API products associated with the developer app. |
-| | `string` | Developer app family. |
-| | `string` | ID of the developer app. |
-| | `array` | List of attributes for the developer app. |
-| | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. |
-| | `string` | Output only. Time the developer app was created in milliseconds since epoch. |
-| | `array` | Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. |
-| | `string` | ID of the developer. |
-| | `string` | Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. |
-| | `string` | Output only. Time the developer app was modified in milliseconds since epoch. |
-| | `array` | Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. |
-| | `string` | Status of the credential. Valid values include `approved` or `revoked`. |
+| | `string` | Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*). |
+| | `array` | List of API products associated with the AppGroup app. |
+| | `string` | Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*). |
+| | `string` | Immutable. ID of the AppGroup app. |
+| | `array` | List of attributes for the AppGroup app. |
+| | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps. |
+| | `string` | Output only. Time the AppGroup app was created in milliseconds since epoch. |
+| | `array` | Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products. |
+| | `string` | Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. |
+| | `string` | Output only. Time the AppGroup app was modified in milliseconds since epoch. |
+| | `array` | Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app. |
+| | `string` | Status of the App. Valid values include `approved` or `revoked`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -56,9 +58,124 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI. |
| | `DELETE` | | Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted. |
| | `DELETE` | | Deletes a developer app. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted. |
-| | `UPDATE` | | Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. |
-| | `UPDATE` | | Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. |
-| | `EXEC` | | Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. |
-| | `EXEC` | | Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). |
+| | `EXEC` | | Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. |
| | `EXEC` | | Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. |
| | `EXEC` | | Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approve` or `revoke`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approve` or `revoke`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API. |
+| | `EXEC` | | Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. |
+
+## `SELECT` examples
+
+Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).
+
+```sql
+SELECT
+name,
+apiProducts,
+appGroup,
+appId,
+attributes,
+callbackUrl,
+createdAt,
+credentials,
+keyExpiresIn,
+lastModifiedAt,
+scopes,
+status
+FROM google.apigee.apps
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new apps
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.apps (
+appgroupsId,
+organizationsId,
+createdAt,
+apiProducts,
+attributes,
+keyExpiresIn,
+appGroup,
+credentials,
+scopes,
+status,
+name,
+lastModifiedAt,
+callbackUrl,
+appId
+)
+SELECT
+'{{ appgroupsId }}',
+'{{ organizationsId }}',
+'{{ createdAt }}',
+'{{ apiProducts }}',
+'{{ attributes }}',
+'{{ keyExpiresIn }}',
+'{{ appGroup }}',
+'{{ credentials }}',
+'{{ scopes }}',
+'{{ status }}',
+'{{ name }}',
+'{{ lastModifiedAt }}',
+'{{ callbackUrl }}',
+'{{ appId }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: apiProducts
+ value: '{{ apiProducts }}'
+ - name: attributes
+ value: '{{ attributes }}'
+ - name: keyExpiresIn
+ value: '{{ keyExpiresIn }}'
+ - name: appGroup
+ value: '{{ appGroup }}'
+ - name: credentials
+ value: '{{ credentials }}'
+ - name: scopes
+ value: '{{ scopes }}'
+ - name: status
+ value: '{{ status }}'
+ - name: name
+ value: '{{ name }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: callbackUrl
+ value: '{{ callbackUrl }}'
+ - name: appId
+ value: '{{ appId }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified app resource.
+
+```sql
+DELETE FROM google.apigee.apps
+WHERE appgroupsId = '{{ appgroupsId }}'
+AND appsId = '{{ appsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/archive_deployments/index.md b/docs/google-docs/providers/google/apigee/archive_deployments/index.md
index eb700045ae..50d12383a7 100644
--- a/docs/google-docs/providers/google/apigee/archive_deployments/index.md
+++ b/docs/google-docs/providers/google/apigee/archive_deployments/index.md
@@ -1,3 +1,4 @@
+
---
title: archive_deployments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- archive_deployments
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an archive_deployment
resource or lists archive_deployments
in a region
## Overview
@@ -30,12 +32,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. |
+| | `string` | Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. |
| | `string` | Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. |
| | `string` | Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. |
-| | `object` | User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. |
-| | `string` | Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` |
+| | `object` | User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. |
+| | `string` | Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` |
| | `string` | Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -44,6 +47,112 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new ArchiveDeployment. |
| | `DELETE` | | Deletes an archive deployment. |
| | `UPDATE` | | Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable. |
-| | `EXEC` | | Lists the ArchiveDeployments in the specified Environment. |
| | `EXEC` | | Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL. |
| | `EXEC` | | Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` |
+
+## `SELECT` examples
+
+Lists the ArchiveDeployments in the specified Environment.
+
+```sql
+SELECT
+name,
+createdAt,
+gcsUri,
+labels,
+operation,
+updatedAt
+FROM google.apigee.archive_deployments
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new archive_deployments
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.archive_deployments (
+environmentsId,
+organizationsId,
+createdAt,
+gcsUri,
+name,
+operation,
+updatedAt,
+labels
+)
+SELECT
+'{{ environmentsId }}',
+'{{ organizationsId }}',
+'{{ createdAt }}',
+'{{ gcsUri }}',
+'{{ name }}',
+'{{ operation }}',
+'{{ updatedAt }}',
+'{{ labels }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: gcsUri
+ value: '{{ gcsUri }}'
+ - name: name
+ value: '{{ name }}'
+ - name: operation
+ value: '{{ operation }}'
+ - name: updatedAt
+ value: '{{ updatedAt }}'
+ - name: labels
+ value: '{{ labels }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a archive_deployment only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.archive_deployments
+SET
+createdAt = '{{ createdAt }}',
+gcsUri = '{{ gcsUri }}',
+name = '{{ name }}',
+operation = '{{ operation }}',
+updatedAt = '{{ updatedAt }}',
+labels = '{{ labels }}'
+WHERE
+archiveDeploymentsId = '{{ archiveDeploymentsId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified archive_deployment resource.
+
+```sql
+DELETE FROM google.apigee.archive_deployments
+WHERE archiveDeploymentsId = '{{ archiveDeploymentsId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/attachments/index.md b/docs/google-docs/providers/google/apigee/attachments/index.md
index 8060c28c3f..1af30e9816 100644
--- a/docs/google-docs/providers/google/apigee/attachments/index.md
+++ b/docs/google-docs/providers/google/apigee/attachments/index.md
@@ -1,3 +1,4 @@
+
---
title: attachments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- attachments
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an attachment
resource or lists attachments
in a region
## Overview
@@ -34,6 +36,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The time at which the environment group attachment was created as milliseconds since epoch. |
| | `string` | Required. ID of the attached environment. |
| | `string` | Output only. ID of the environment group. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -45,5 +48,81 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid. |
| | `DELETE` | | Deletes an environment group attachment. |
| | `DELETE` | | Deletes an attachment. **Note:** Not supported for Apigee hybrid. |
-| | `EXEC` | | Lists all attachments of an environment group. |
-| | `EXEC` | | Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid. |
+
+## `SELECT` examples
+
+Lists all attachments of an environment group.
+
+```sql
+SELECT
+name,
+createdAt,
+environment,
+environmentGroupId
+FROM google.apigee.attachments
+WHERE envgroupsId = '{{ envgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new attachments
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.attachments (
+envgroupsId,
+organizationsId,
+createdAt,
+environmentGroupId,
+environment,
+name
+)
+SELECT
+'{{ envgroupsId }}',
+'{{ organizationsId }}',
+'{{ createdAt }}',
+'{{ environmentGroupId }}',
+'{{ environment }}',
+'{{ name }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: environmentGroupId
+ value: '{{ environmentGroupId }}'
+ - name: environment
+ value: '{{ environment }}'
+ - name: name
+ value: '{{ name }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified attachment resource.
+
+```sql
+DELETE FROM google.apigee.attachments
+WHERE attachmentsId = '{{ attachmentsId }}'
+AND envgroupsId = '{{ envgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/attributes/index.md b/docs/google-docs/providers/google/apigee/attributes/index.md
index 53b0864991..c2e6298ee5 100644
--- a/docs/google-docs/providers/google/apigee/attributes/index.md
+++ b/docs/google-docs/providers/google/apigee/attributes/index.md
@@ -1,3 +1,4 @@
+
---
title: attributes
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- attributes
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an attribute
resource or lists attributes
in a region
## Overview
@@ -32,6 +34,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | API key of the attribute. |
| | `string` | Value of the attribute. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -44,3 +47,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `DELETE` | | Deletes an API product attribute. |
| | `DELETE` | | Deletes a developer app attribute. |
| | `DELETE` | | Deletes a developer attribute. |
+
+## `SELECT` examples
+
+Returns a list of all developer attributes.
+
+```sql
+SELECT
+name,
+value
+FROM google.apigee.attributes
+WHERE developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified attribute resource.
+
+```sql
+DELETE FROM google.apigee.attributes
+WHERE attributesId = '{{ attributesId }}'
+AND developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md
index cff524f313..7706e2c8bb 100644
--- a/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md
+++ b/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md
@@ -1,3 +1,4 @@
+
---
title: attributes_api_product_attribute
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- attributes_api_product_attribute
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an attributes_api_product_attribute
resource or lists attributes_api_product_attribute
in a region
## Overview
@@ -28,8 +30,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Updates the value of an API product attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
+
+## `UPDATE` example
+
+Updates a attributes_api_product_attribute only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.attributes_api_product_attribute
+SET
+value = '{{ value }}',
+name = '{{ name }}'
+WHERE
+apiproductsId = '{{ apiproductsId }}'
+AND attributesId = '{{ attributesId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md
index 31568e1c5a..331f19dce4 100644
--- a/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md
+++ b/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md
@@ -1,3 +1,4 @@
+
---
title: attributes_developer_app_attribute
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- attributes_developer_app_attribute
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an attributes_developer_app_attribute
resource or lists attributes_developer_app_attribute
in a region
## Overview
@@ -28,8 +30,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Updates a developer app attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
+
+## `UPDATE` example
+
+Updates a attributes_developer_app_attribute only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.attributes_developer_app_attribute
+SET
+value = '{{ value }}',
+name = '{{ name }}'
+WHERE
+appsId = '{{ appsId }}'
+AND attributesId = '{{ attributesId }}'
+AND developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md
index 4520cf1f20..9635c09352 100644
--- a/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md
+++ b/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md
@@ -1,3 +1,4 @@
+
---
title: attributes_developer_attribute
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- attributes_developer_attribute
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an attributes_developer_attribute
resource or lists attributes_developer_attribute
in a region
## Overview
@@ -28,8 +30,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Updates a developer attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
+
+## `UPDATE` example
+
+Updates a attributes_developer_attribute only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.attributes_developer_attribute
+SET
+value = '{{ value }}',
+name = '{{ name }}'
+WHERE
+attributesId = '{{ attributesId }}'
+AND developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/balance/index.md b/docs/google-docs/providers/google/apigee/balance/index.md
index 3078601772..5bfce0e5c1 100644
--- a/docs/google-docs/providers/google/apigee/balance/index.md
+++ b/docs/google-docs/providers/google/apigee/balance/index.md
@@ -1,3 +1,4 @@
+
---
title: balance
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- balance
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an balance
resource or lists balance
in a region
## Overview
@@ -28,7 +30,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
diff --git a/docs/google-docs/providers/google/apigee/caches/index.md b/docs/google-docs/providers/google/apigee/caches/index.md
index 98e9cbbb47..130a69e618 100644
--- a/docs/google-docs/providers/google/apigee/caches/index.md
+++ b/docs/google-docs/providers/google/apigee/caches/index.md
@@ -1,3 +1,4 @@
+
---
title: caches
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- caches
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an cach
resource or lists caches
in a region
## Overview
@@ -28,8 +30,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `DELETE` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `DELETE` | | Deletes a cache. |
+
+## `DELETE` example
+
+Deletes the specified cach resource.
+
+```sql
+DELETE FROM google.apigee.caches
+WHERE cachesId = '{{ cachesId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md
index b7830a9c9e..26bfc82496 100644
--- a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md
+++ b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md
@@ -1,3 +1,4 @@
+
---
title: canaryevaluations
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- canaryevaluations
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an canaryevaluation
resource or lists canaryevaluations
in a region
## Overview
@@ -39,8 +41,102 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The current state of the canary evaluation. |
| | `string` | Required. The newer version that is serving requests. |
| | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets a CanaryEvaluation for an organization. |
| | `INSERT` | | Creates a new canary evaluation for an organization. |
+
+## `SELECT` examples
+
+Gets a CanaryEvaluation for an organization.
+
+```sql
+SELECT
+name,
+control,
+createTime,
+endTime,
+metricLabels,
+startTime,
+state,
+treatment,
+verdict
+FROM google.apigee.canaryevaluations
+WHERE canaryevaluationsId = '{{ canaryevaluationsId }}'
+AND instancesId = '{{ instancesId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new canaryevaluations
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.canaryevaluations (
+instancesId,
+organizationsId,
+startTime,
+endTime,
+control,
+metricLabels,
+createTime,
+treatment,
+name,
+verdict,
+state
+)
+SELECT
+'{{ instancesId }}',
+'{{ organizationsId }}',
+'{{ startTime }}',
+'{{ endTime }}',
+'{{ control }}',
+'{{ metricLabels }}',
+'{{ createTime }}',
+'{{ treatment }}',
+'{{ name }}',
+'{{ verdict }}',
+'{{ state }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: startTime
+ value: '{{ startTime }}'
+ - name: endTime
+ value: '{{ endTime }}'
+ - name: control
+ value: '{{ control }}'
+ - name: metricLabels
+ value: '{{ metricLabels }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: treatment
+ value: '{{ treatment }}'
+ - name: name
+ value: '{{ name }}'
+ - name: verdict
+ value: '{{ verdict }}'
+ - name: state
+ value: '{{ state }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/apigee/create/index.md b/docs/google-docs/providers/google/apigee/create/index.md
index 602ceacb2c..8e559ae91d 100644
--- a/docs/google-docs/providers/google/apigee/create/index.md
+++ b/docs/google-docs/providers/google/apigee/create/index.md
@@ -1,3 +1,4 @@
+
---
title: create
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- create
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an create
resource or lists create
in a region
## Overview
@@ -28,8 +30,84 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `INSERT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `INSERT` | | Creates a custom consumer key and secret for a developer app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteDeveloperAppKey API. **Note**: All keys start out with status=approved, even if status=revoked is passed when the key is created. To revoke a key, use the UpdateDeveloperAppKey API. |
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new create
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.create (
+appsId,
+developersId,
+organizationsId,
+consumerKey,
+expiresInSeconds,
+consumerSecret,
+attributes,
+apiProducts,
+status,
+issuedAt,
+scopes,
+expiresAt
+)
+SELECT
+'{{ appsId }}',
+'{{ developersId }}',
+'{{ organizationsId }}',
+'{{ consumerKey }}',
+'{{ expiresInSeconds }}',
+'{{ consumerSecret }}',
+'{{ attributes }}',
+'{{ apiProducts }}',
+'{{ status }}',
+'{{ issuedAt }}',
+'{{ scopes }}',
+'{{ expiresAt }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: consumerKey
+ value: '{{ consumerKey }}'
+ - name: expiresInSeconds
+ value: '{{ expiresInSeconds }}'
+ - name: consumerSecret
+ value: '{{ consumerSecret }}'
+ - name: attributes
+ value: '{{ attributes }}'
+ - name: apiProducts
+ value: '{{ apiProducts }}'
+ - name: status
+ value: '{{ status }}'
+ - name: issuedAt
+ value: '{{ issuedAt }}'
+ - name: scopes
+ value: '{{ scopes }}'
+ - name: expiresAt
+ value: '{{ expiresAt }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/apigee/data/index.md b/docs/google-docs/providers/google/apigee/data/index.md
index 6794478c18..64b5fbbd33 100644
--- a/docs/google-docs/providers/google/apigee/data/index.md
+++ b/docs/google-docs/providers/google/apigee/data/index.md
@@ -1,3 +1,4 @@
+
---
title: data
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- data
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an datum
resource or lists data
in a region
## Overview
@@ -32,7 +34,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `boolean` | Flag indicating whether a transaction is completed or not |
| | `array` | List of debug data collected by runtime plane at various defined points in the flow. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the debug data from a transaction. |
+
+## `SELECT` examples
+
+Gets the debug data from a transaction.
+
+```sql
+SELECT
+completed,
+point
+FROM google.apigee.data
+WHERE apisId = '{{ apisId }}'
+AND dataId = '{{ dataId }}'
+AND debugsessionsId = '{{ debugsessionsId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND revisionsId = '{{ revisionsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/datacollectors/index.md b/docs/google-docs/providers/google/apigee/datacollectors/index.md
index 9e394d0bc7..3e4d0ec424 100644
--- a/docs/google-docs/providers/google/apigee/datacollectors/index.md
+++ b/docs/google-docs/providers/google/apigee/datacollectors/index.md
@@ -1,3 +1,4 @@
+
---
title: datacollectors
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- datacollectors
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an datacollector
resource or lists datacollectors
in a region
## Overview
@@ -35,6 +37,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. The time at which the data collector was created in milliseconds since the epoch. |
| | `string` | Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. |
| | `string` | Immutable. The type of data this data collector will collect. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,4 +46,99 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new data collector. |
| | `DELETE` | | Deletes a data collector. |
| | `UPDATE` | | Updates a data collector. |
-| | `EXEC` | | Lists all data collectors. |
+
+## `SELECT` examples
+
+Lists all data collectors.
+
+```sql
+SELECT
+name,
+description,
+createdAt,
+lastModifiedAt,
+type
+FROM google.apigee.datacollectors
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new datacollectors
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.datacollectors (
+organizationsId,
+type,
+createdAt,
+description,
+name,
+lastModifiedAt
+)
+SELECT
+'{{ organizationsId }}',
+'{{ type }}',
+'{{ createdAt }}',
+'{{ description }}',
+'{{ name }}',
+'{{ lastModifiedAt }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: type
+ value: '{{ type }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: description
+ value: '{{ description }}'
+ - name: name
+ value: '{{ name }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a datacollector only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.datacollectors
+SET
+type = '{{ type }}',
+createdAt = '{{ createdAt }}',
+description = '{{ description }}',
+name = '{{ name }}',
+lastModifiedAt = '{{ lastModifiedAt }}'
+WHERE
+datacollectorsId = '{{ datacollectorsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified datacollector resource.
+
+```sql
+DELETE FROM google.apigee.datacollectors
+WHERE datacollectorsId = '{{ datacollectorsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/datastores/index.md b/docs/google-docs/providers/google/apigee/datastores/index.md
index 2fc90d0460..c8c5e82c20 100644
--- a/docs/google-docs/providers/google/apigee/datastores/index.md
+++ b/docs/google-docs/providers/google/apigee/datastores/index.md
@@ -1,3 +1,4 @@
+
---
title: datastores
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- datastores
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an datastore
resource or lists datastores
in a region
## Overview
@@ -35,8 +37,9 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. Display name in UI |
| | `string` | Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z |
| | `string` | Output only. Organization that the datastore belongs to |
-| | `string` | Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` |
+| | `string` | Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` |
| | `string` | Destination storage type. Supported types `gcs` or `bigquery`. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -44,5 +47,94 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | List Datastores |
| | `INSERT` | | Create a Datastore for an org |
| | `DELETE` | | Delete a Datastore from an org. |
-| | `UPDATE` | | Update a Datastore |
| | `EXEC` | | Test if Datastore configuration is correct. This includes checking if credentials provided by customer have required permissions in target destination storage |
+| | `EXEC` | | Update a Datastore |
+
+## `SELECT` examples
+
+List Datastores
+
+```sql
+SELECT
+createTime,
+datastoreConfig,
+displayName,
+lastUpdateTime,
+org,
+self,
+targetType
+FROM google.apigee.datastores
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new datastores
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.datastores (
+organizationsId,
+datastoreConfig,
+lastUpdateTime,
+org,
+displayName,
+self,
+targetType,
+createTime
+)
+SELECT
+'{{ organizationsId }}',
+'{{ datastoreConfig }}',
+'{{ lastUpdateTime }}',
+'{{ org }}',
+'{{ displayName }}',
+'{{ self }}',
+'{{ targetType }}',
+'{{ createTime }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: datastoreConfig
+ value: '{{ datastoreConfig }}'
+ - name: lastUpdateTime
+ value: '{{ lastUpdateTime }}'
+ - name: org
+ value: '{{ org }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: self
+ value: '{{ self }}'
+ - name: targetType
+ value: '{{ targetType }}'
+ - name: createTime
+ value: '{{ createTime }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified datastore resource.
+
+```sql
+DELETE FROM google.apigee.datastores
+WHERE datastoresId = '{{ datastoresId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/debugsessions/index.md b/docs/google-docs/providers/google/apigee/debugsessions/index.md
index 57c4bc47bd..06979ba9bb 100644
--- a/docs/google-docs/providers/google/apigee/debugsessions/index.md
+++ b/docs/google-docs/providers/google/apigee/debugsessions/index.md
@@ -1,3 +1,4 @@
+
---
title: debugsessions
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- debugsessions
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an debugsession
resource or lists debugsessions
in a region
## Overview
@@ -37,10 +39,98 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided. |
| | `integer` | Optional. The maximum number of bytes captured from the response payload. Min = 0, Max = 5120, Default = 5120. |
| | `integer` | Optional. The length of time, in seconds, that this debug session is valid, starting from when it's received in the control plane. Min = 1, Max = 15, Default = 10. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Retrieves a debug session. |
| | `SELECT` | | Lists debug sessions that are currently active in the given API Proxy revision. |
| | `INSERT` | | Creates a debug session for a deployed API Proxy revision. |
-| | `EXEC` | | Lists debug sessions that are currently active in the given API Proxy revision. |
+
+## `SELECT` examples
+
+Lists debug sessions that are currently active in the given API Proxy revision.
+
+```sql
+SELECT
+name,
+count,
+createTime,
+filter,
+timeout,
+tracesize,
+validity
+FROM google.apigee.debugsessions
+WHERE apisId = '{{ apisId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND revisionsId = '{{ revisionsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new debugsessions
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.debugsessions (
+apisId,
+environmentsId,
+organizationsId,
+revisionsId,
+filter,
+createTime,
+timeout,
+count,
+validity,
+tracesize,
+name
+)
+SELECT
+'{{ apisId }}',
+'{{ environmentsId }}',
+'{{ organizationsId }}',
+'{{ revisionsId }}',
+'{{ filter }}',
+'{{ createTime }}',
+'{{ timeout }}',
+'{{ count }}',
+'{{ validity }}',
+'{{ tracesize }}',
+'{{ name }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: filter
+ value: '{{ filter }}'
+ - name: createTime
+ value: '{{ createTime }}'
+ - name: timeout
+ value: '{{ timeout }}'
+ - name: count
+ value: '{{ count }}'
+ - name: validity
+ value: '{{ validity }}'
+ - name: tracesize
+ value: '{{ tracesize }}'
+ - name: name
+ value: '{{ name }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/apigee/debugsessions_data/index.md b/docs/google-docs/providers/google/apigee/debugsessions_data/index.md
index 32722b3ca3..25c1e1156e 100644
--- a/docs/google-docs/providers/google/apigee/debugsessions_data/index.md
+++ b/docs/google-docs/providers/google/apigee/debugsessions_data/index.md
@@ -1,3 +1,4 @@
+
---
title: debugsessions_data
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- debugsessions_data
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an debugsessions_datum
resource or lists debugsessions_data
in a region
## Overview
@@ -28,8 +30,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `DELETE` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `DELETE` | | Deletes the data from a debug session. This does not cancel the debug session or prevent further data from being collected if the session is still active in runtime pods. |
+
+## `DELETE` example
+
+Deletes the specified debugsessions_datum resource.
+
+```sql
+DELETE FROM google.apigee.debugsessions_data
+WHERE apisId = '{{ apisId }}'
+AND debugsessionsId = '{{ debugsessionsId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}'
+AND revisionsId = '{{ revisionsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md b/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md
index 7c25c4ca9a..fb1cd59cb5 100644
--- a/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md
+++ b/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md
@@ -1,3 +1,4 @@
+
---
title: deployed_ingress_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- deployed_ingress_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an deployed_ingress_config
resource or lists deployed_ingress_config
in a region
## Overview
@@ -30,12 +32,28 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`. |
+| | `string` | Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`. |
| | `array` | List of environment groups in the organization. |
| | `string` | Time at which the IngressConfig revision was created. |
| | `string` | Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed. |
| | `string` | A unique id for the ingress config that will only change if the organization is deleted and recreated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the deployed ingress configuration for an organization. |
+
+## `SELECT` examples
+
+Gets the deployed ingress configuration for an organization.
+
+```sql
+SELECT
+name,
+environmentGroups,
+revisionCreateTime,
+revisionId,
+uid
+FROM google.apigee.deployed_ingress_config
+WHERE organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/deployments/index.md b/docs/google-docs/providers/google/apigee/deployments/index.md
index 98fd375d8c..a77829a3b7 100644
--- a/docs/google-docs/providers/google/apigee/deployments/index.md
+++ b/docs/google-docs/providers/google/apigee/deployments/index.md
@@ -1,3 +1,4 @@
+
---
title: deployments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- deployments
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an deployment
resource or lists deployments
in a region
## Overview
@@ -28,6 +30,10 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `array` | List of deployments. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -35,9 +41,21 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists all deployments of an API proxy revision. |
| | `SELECT` | | Lists all deployments of API proxies or shared flows. |
| | `SELECT` | | Lists all deployments of an API proxy in an environment. |
+| | `SELECT` | | Gets a particular deployment of Api proxy or a shared flow in an environment |
| | `SELECT` | | Lists all deployments of API proxies or shared flows in an environment. |
| | `SELECT` | | Lists all deployments of a shared flow in an environment. |
| | `SELECT` | | Lists all deployments of a shared flow. |
| | `SELECT` | | Lists all deployments of a shared flow revision. |
-| | `EXEC` | | Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` |
-| | `EXEC` | | Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` |
+| | `EXEC` | | Generates a report for a dry run analysis of a DeployApiProxy request without committing the deployment. In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run DeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` |
+| | `EXEC` | | Generates a report for a dry run analysis of an UndeployApiProxy request without committing the undeploy. In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run UndeployApiProxy request. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport`, two permissions are required: * `apigee.deployments.delete` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.undeploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}` |
+
+## `SELECT` examples
+
+Lists all deployments of API proxies or shared flows.
+
+```sql
+SELECT
+deployments
+FROM google.apigee.deployments
+WHERE organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/deployments_iam_policies/index.md b/docs/google-docs/providers/google/apigee/deployments_iam_policies/index.md
new file mode 100644
index 0000000000..9b5b03e88f
--- /dev/null
+++ b/docs/google-docs/providers/google/apigee/deployments_iam_policies/index.md
@@ -0,0 +1,59 @@
+
+---
+title: deployments_iam_policies
+hide_title: false
+hide_table_of_contents: false
+keywords:
+ - deployments_iam_policies
+ - apigee
+ - google
+ - stackql
+ - infrastructure-as-code
+ - configuration-as-data
+ - cloud inventory
+description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL
+custom_edit_url: null
+image: /img/providers/google/stackql-google-provider-featured-image.png
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Creates, updates, deletes or gets an deployments_iam_policy
resource or lists deployments_iam_policies
in a region
+
+## Overview
+
+Name | deployments_iam_policies |
+Type | Resource |
+Id | |
+
+
+## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `object` | 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. |
+| | `array` | 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`. |
+| | `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). |
+
+## Methods
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the IAM policy on a deployment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.getIamPolicy` permission to call this API. |
+| | `EXEC` | | Sets the IAM policy on a deployment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.setIamPolicy` permission to call this API. |
+| | `EXEC` | | Tests the permissions of a user on a deployment, and returns a subset of permissions that the user has on the deployment. If the deployment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned). |
+
+## `SELECT` examples
+
+Gets the IAM policy on a deployment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.getIamPolicy` permission to call this API.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.apigee.deployments_iam_policies
+WHERE deploymentsId = '{{ deploymentsId }}'
+AND environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/developers/index.md b/docs/google-docs/providers/google/apigee/developers/index.md
index 41e2a54c8e..547298eb63 100644
--- a/docs/google-docs/providers/google/apigee/developers/index.md
+++ b/docs/google-docs/providers/google/apigee/developers/index.md
@@ -1,3 +1,4 @@
+
---
title: developers
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- developers
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an developer
resource or lists developers
in a region
## Overview
@@ -44,6 +46,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Name of the Apigee organization in which the developer resides. |
| | `string` | Output only. Status of the developer. Valid values are `active` and `inactive`. |
| | `string` | Required. User name of the developer. Not used by Apigee hybrid. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -51,6 +54,130 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters. |
| | `INSERT` | | Creates a developer. Once created, the developer can register an app and obtain an API key. At creation time, a developer is set as `active`. To change the developer status, use the SetDeveloperStatus API. |
| | `DELETE` | | Deletes a developer. All apps and API keys associated with the developer are also removed. **Warning**: This API will permanently delete the developer and related artifacts. To avoid permanently deleting developers and their artifacts, set the developer status to `inactive` using the SetDeveloperStatus API. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted. |
-| | `UPDATE` | | Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
| | `EXEC` | | Updates developer attributes. This API replaces the existing attributes with those specified in the request. Add new attributes, and include or exclude any existing attributes that you want to retain or remove, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
| | `EXEC` | | Sets the status of a developer. A developer is `active` by default. If you set a developer's status to `inactive`, the API keys assigned to the developer apps are no longer valid even though the API keys are set to `approved`. Inactive developers can still sign in to the developer portal and create apps; however, any new API keys generated during app creation won't work. To set the status of a developer, set the `action` query parameter to `active` or `inactive`, and the `Content-Type` header to `application/octet-stream`. If successful, the API call returns the following HTTP status code: `204 No Content` |
+| | `EXEC` | | Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. |
+
+## `SELECT` examples
+
+Lists all developers in an organization by email address. By default, the response does not include company developers. Set the `includeCompany` query parameter to `true` to include company developers. **Note**: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the `startKey` and `count` query parameters.
+
+```sql
+SELECT
+accessType,
+appFamily,
+apps,
+attributes,
+companies,
+createdAt,
+developerId,
+email,
+firstName,
+lastModifiedAt,
+lastName,
+organizationName,
+status,
+userName
+FROM google.apigee.developers
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new developers
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.developers (
+organizationsId,
+userName,
+lastModifiedAt,
+apps,
+companies,
+developerId,
+attributes,
+lastName,
+firstName,
+accessType,
+status,
+appFamily,
+organizationName,
+email,
+createdAt
+)
+SELECT
+'{{ organizationsId }}',
+'{{ userName }}',
+'{{ lastModifiedAt }}',
+'{{ apps }}',
+'{{ companies }}',
+'{{ developerId }}',
+'{{ attributes }}',
+'{{ lastName }}',
+'{{ firstName }}',
+'{{ accessType }}',
+'{{ status }}',
+'{{ appFamily }}',
+'{{ organizationName }}',
+'{{ email }}',
+'{{ createdAt }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: userName
+ value: '{{ userName }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: apps
+ value: '{{ apps }}'
+ - name: companies
+ value: '{{ companies }}'
+ - name: developerId
+ value: '{{ developerId }}'
+ - name: attributes
+ value: '{{ attributes }}'
+ - name: lastName
+ value: '{{ lastName }}'
+ - name: firstName
+ value: '{{ firstName }}'
+ - name: accessType
+ value: '{{ accessType }}'
+ - name: status
+ value: '{{ status }}'
+ - name: appFamily
+ value: '{{ appFamily }}'
+ - name: organizationName
+ value: '{{ organizationName }}'
+ - name: email
+ value: '{{ email }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified developer resource.
+
+```sql
+DELETE FROM google.apigee.developers
+WHERE developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/developers_balance/index.md b/docs/google-docs/providers/google/apigee/developers_balance/index.md
index f7d90ab07f..6eaa9d44d2 100644
--- a/docs/google-docs/providers/google/apigee/developers_balance/index.md
+++ b/docs/google-docs/providers/google/apigee/developers_balance/index.md
@@ -1,3 +1,4 @@
+
---
title: developers_balance
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- developers_balance
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an developers_balance
resource or lists developers_balance
in a region
## Overview
@@ -28,7 +30,23 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `array` | Output only. List of all wallets. Each individual wallet stores the account balance for a particular currency. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the account balance for the developer. |
+
+## `SELECT` examples
+
+Gets the account balance for the developer.
+
+```sql
+SELECT
+wallets
+FROM google.apigee.developers_balance
+WHERE developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/developers_monetization_config/index.md b/docs/google-docs/providers/google/apigee/developers_monetization_config/index.md
index e1adff6ea6..f4266daee2 100644
--- a/docs/google-docs/providers/google/apigee/developers_monetization_config/index.md
+++ b/docs/google-docs/providers/google/apigee/developers_monetization_config/index.md
@@ -1,3 +1,4 @@
+
---
title: developers_monetization_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- developers_monetization_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an developers_monetization_config
resource or lists developers_monetization_config
in a region
## Overview
@@ -28,8 +30,24 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
+| Name | Datatype | Description |
+|:-----|:---------|:------------|
+| | `string` | Billing type. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the monetization configuration for the developer. |
| | `EXEC` | | Updates the monetization configuration for the developer. |
+
+## `SELECT` examples
+
+Gets the monetization configuration for the developer.
+
+```sql
+SELECT
+billingType
+FROM google.apigee.developers_monetization_config
+WHERE developersId = '{{ developersId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md
index 6deeb49e2a..fc5bfc8592 100644
--- a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md
+++ b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md
@@ -1,3 +1,4 @@
+
---
title: endpoint_attachments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- endpoint_attachments
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an endpoint_attachment
resource or lists endpoint_attachments
in a region
## Overview
@@ -30,12 +32,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` |
+| | `string` | Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` |
| | `string` | Output only. State of the endpoint attachment connection to the service attachment. |
| | `string` | Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server. |
| | `string` | Required. Location of the endpoint attachment. |
| | `string` | Format: projects/*/regions/*/serviceAttachments/* |
| | `string` | Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,4 +46,87 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `SELECT` | | Lists the endpoint attachments in an organization. |
| | `INSERT` | | Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid. |
| | `DELETE` | | Deletes an endpoint attachment. |
-| | `EXEC` | | Lists the endpoint attachments in an organization. |
+
+## `SELECT` examples
+
+Lists the endpoint attachments in an organization.
+
+```sql
+SELECT
+name,
+connectionState,
+host,
+location,
+serviceAttachment,
+state
+FROM google.apigee.endpoint_attachments
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new endpoint_attachments
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.endpoint_attachments (
+organizationsId,
+name,
+connectionState,
+serviceAttachment,
+location,
+state,
+host
+)
+SELECT
+'{{ organizationsId }}',
+'{{ name }}',
+'{{ connectionState }}',
+'{{ serviceAttachment }}',
+'{{ location }}',
+'{{ state }}',
+'{{ host }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: name
+ value: '{{ name }}'
+ - name: connectionState
+ value: '{{ connectionState }}'
+ - name: serviceAttachment
+ value: '{{ serviceAttachment }}'
+ - name: location
+ value: '{{ location }}'
+ - name: state
+ value: '{{ state }}'
+ - name: host
+ value: '{{ host }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified endpoint_attachment resource.
+
+```sql
+DELETE FROM google.apigee.endpoint_attachments
+WHERE endpointAttachmentsId = '{{ endpointAttachmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/entries/index.md b/docs/google-docs/providers/google/apigee/entries/index.md
index fcf9c6c2ae..387890ff39 100644
--- a/docs/google-docs/providers/google/apigee/entries/index.md
+++ b/docs/google-docs/providers/google/apigee/entries/index.md
@@ -1,3 +1,4 @@
+
---
title: entries
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- entries
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an entry
resource or lists entries
in a region
## Overview
@@ -32,6 +34,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
|:-----|:---------|:------------|
| | `string` | Resource URI that can be used to identify the scope of the key value map entries. |
| | `string` | Required. Data or payload that is being retrieved and associated with the unique key. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -47,9 +50,74 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `DELETE` | | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. |
| | `DELETE` | | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. |
| | `DELETE` | | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. |
-| | `UPDATE` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
-| | `UPDATE` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
-| | `UPDATE` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
-| | `EXEC` | | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. |
-| | `EXEC` | | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. |
-| | `EXEC` | | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. |
+| | `EXEC` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
+| | `EXEC` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
+| | `EXEC` | | Update key value entry scoped to an organization, environment, or API proxy for an existing key. |
+
+## `SELECT` examples
+
+Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher.
+
+```sql
+SELECT
+name,
+value
+FROM google.apigee.entries
+WHERE keyvaluemapsId = '{{ keyvaluemapsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new entries
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.entries (
+keyvaluemapsId,
+organizationsId,
+value,
+name
+)
+SELECT
+'{{ keyvaluemapsId }}',
+'{{ organizationsId }}',
+'{{ value }}',
+'{{ name }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: value
+ value: '{{ value }}'
+ - name: name
+ value: '{{ name }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified entry resource.
+
+```sql
+DELETE FROM google.apigee.entries
+WHERE entriesId = '{{ entriesId }}'
+AND keyvaluemapsId = '{{ keyvaluemapsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/envgroups/index.md b/docs/google-docs/providers/google/apigee/envgroups/index.md
index 02efc6da84..599c1d3f2c 100644
--- a/docs/google-docs/providers/google/apigee/envgroups/index.md
+++ b/docs/google-docs/providers/google/apigee/envgroups/index.md
@@ -1,3 +1,4 @@
+
---
title: envgroups
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- envgroups
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an envgroup
resource or lists envgroups
in a region
## Overview
@@ -35,6 +37,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | Required. Host names for this environment group. |
| | `string` | Output only. The time at which the environment group was last updated as milliseconds since epoch. |
| | `string` | Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -43,4 +46,99 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | Creates a new environment group. |
| | `DELETE` | | Deletes an environment group. |
| | `UPDATE` | | Updates an environment group. |
-| | `EXEC` | | Lists all environment groups. |
+
+## `SELECT` examples
+
+Lists all environment groups.
+
+```sql
+SELECT
+name,
+createdAt,
+hostnames,
+lastModifiedAt,
+state
+FROM google.apigee.envgroups
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new envgroups
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.envgroups (
+organizationsId,
+lastModifiedAt,
+state,
+name,
+hostnames,
+createdAt
+)
+SELECT
+'{{ organizationsId }}',
+'{{ lastModifiedAt }}',
+'{{ state }}',
+'{{ name }}',
+'{{ hostnames }}',
+'{{ createdAt }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: state
+ value: '{{ state }}'
+ - name: name
+ value: '{{ name }}'
+ - name: hostnames
+ value: '{{ hostnames }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+
+```
+
+
+
+## `UPDATE` example
+
+Updates a envgroup only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.envgroups
+SET
+lastModifiedAt = '{{ lastModifiedAt }}',
+state = '{{ state }}',
+name = '{{ name }}',
+hostnames = '{{ hostnames }}',
+createdAt = '{{ createdAt }}'
+WHERE
+envgroupsId = '{{ envgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `DELETE` example
+
+Deletes the specified envgroup resource.
+
+```sql
+DELETE FROM google.apigee.envgroups
+WHERE envgroupsId = '{{ envgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md b/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md
index a0175ecca8..7ae10cd352 100644
--- a/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md
+++ b/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md
@@ -1,3 +1,4 @@
+
---
title: envgroups_deployed_ingress_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- envgroups_deployed_ingress_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an envgroups_deployed_ingress_config
resource or lists envgroups_deployed_ingress_config
in a region
## Overview
@@ -30,14 +32,33 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. |
+| | `string` | Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. |
| | `array` | A list of proxies in each deployment group for proxy chaining calls. |
| | `array` | Host names for the environment group. |
| | `string` | When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group. |
| | `string` | Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. |
| | `array` | Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. |
| | `string` | A unique id for the environment group config that will only change if the environment group is deleted and recreated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the deployed ingress configuration for an environment group. |
+
+## `SELECT` examples
+
+Gets the deployed ingress configuration for an environment group.
+
+```sql
+SELECT
+name,
+endpointChainingRules,
+hostnames,
+location,
+revisionId,
+routingRules,
+uid
+FROM google.apigee.envgroups_deployed_ingress_config
+WHERE envgroupsId = '{{ envgroupsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments/index.md b/docs/google-docs/providers/google/apigee/environments/index.md
index 7c52986ebb..db2df73071 100644
--- a/docs/google-docs/providers/google/apigee/environments/index.md
+++ b/docs/google-docs/providers/google/apigee/environments/index.md
@@ -1,3 +1,4 @@
+
---
title: environments
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environment
resource or lists environments
in a region
## Overview
@@ -30,19 +32,20 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` |
+| | `string` | Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` |
| | `string` | Optional. Description of the environment. |
| | `string` | Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. |
| | `string` | Output only. Creation time of this environment as milliseconds since epoch. |
| | `string` | Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers |
| | `string` | Optional. Display name for this environment. |
-| | `string` | Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request. |
+| | `string` | Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request. |
| | `boolean` | |
| | `string` | Output only. Last modification time of this environment as milliseconds since epoch. |
| | `object` | NodeConfig for setting the min/max number of nodes associated with the environment. |
| | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. |
| | `string` | Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. |
| | `string` | Optional. EnvironmentType selected for the environment. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
@@ -51,8 +54,128 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `INSERT` | | CreateSecurityProfileEnvironmentAssociation creates profile environment association i.e. attaches environment to security profile. |
| | `DELETE` | | Deletes an environment from an organization. **Warning: You must delete all key value maps and key value entries before you delete an environment.** Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies. |
| | `DELETE` | | DeleteSecurityProfileEnvironmentAssociation removes profile environment association i.e. detaches environment from security profile. |
-| | `UPDATE` | | Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. |
| | `EXEC` | | Updates properties for an Apigee environment with patch semantics using a field mask. **Note:** Not supported for Apigee hybrid. |
| | `EXEC` | | Creates a subscription for the environment's Pub/Sub topic. The server will assign a random name for this subscription. The "name" and "push_config" must *not* be specified. |
| | `EXEC` | | Deletes a subscription for the environment's Pub/Sub topic. |
+| | `EXEC` | | Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. |
| | `EXEC` | | ComputeEnvironmentScores calculates scores for requested time range for the specified security profile and environment. |
+
+## `SELECT` examples
+
+Gets environment details.
+
+```sql
+SELECT
+name,
+description,
+apiProxyType,
+createdAt,
+deploymentType,
+displayName,
+forwardProxyUri,
+hasAttachedFlowHooks,
+lastModifiedAt,
+nodeConfig,
+properties,
+state,
+type
+FROM google.apigee.environments
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new environments
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.environments (
+organizationsId,
+deploymentType,
+forwardProxyUri,
+description,
+state,
+nodeConfig,
+properties,
+name,
+createdAt,
+hasAttachedFlowHooks,
+lastModifiedAt,
+type,
+displayName,
+apiProxyType
+)
+SELECT
+'{{ organizationsId }}',
+'{{ deploymentType }}',
+'{{ forwardProxyUri }}',
+'{{ description }}',
+'{{ state }}',
+'{{ nodeConfig }}',
+'{{ properties }}',
+'{{ name }}',
+'{{ createdAt }}',
+true|false,
+'{{ lastModifiedAt }}',
+'{{ type }}',
+'{{ displayName }}',
+'{{ apiProxyType }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: deploymentType
+ value: '{{ deploymentType }}'
+ - name: forwardProxyUri
+ value: '{{ forwardProxyUri }}'
+ - name: description
+ value: '{{ description }}'
+ - name: state
+ value: '{{ state }}'
+ - name: nodeConfig
+ value: '{{ nodeConfig }}'
+ - name: properties
+ value: '{{ properties }}'
+ - name: name
+ value: '{{ name }}'
+ - name: createdAt
+ value: '{{ createdAt }}'
+ - name: hasAttachedFlowHooks
+ value: '{{ hasAttachedFlowHooks }}'
+ - name: lastModifiedAt
+ value: '{{ lastModifiedAt }}'
+ - name: type
+ value: '{{ type }}'
+ - name: displayName
+ value: '{{ displayName }}'
+ - name: apiProxyType
+ value: '{{ apiProxyType }}'
+
+```
+
+
+
+## `DELETE` example
+
+Deletes the specified environment resource.
+
+```sql
+DELETE FROM google.apigee.environments
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_addons_config/index.md b/docs/google-docs/providers/google/apigee/environments_addons_config/index.md
index 4f38c1ffce..35b263d0a2 100644
--- a/docs/google-docs/providers/google/apigee/environments_addons_config/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_addons_config/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_addons_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_addons_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_addons_config
resource or lists environments_addons_config
in a region
## Overview
@@ -36,7 +38,25 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `object` | Configuration for the Connectors Platform add-on. |
| | `object` | Configuration for the Integration add-on. |
| | `object` | Configuration for the Monetization add-on. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the add-ons config of an environment. |
+
+## `SELECT` examples
+
+Gets the add-ons config of an environment.
+
+```sql
+SELECT
+advancedApiOpsConfig,
+analyticsConfig,
+apiSecurityConfig,
+connectorsPlatformConfig,
+integrationConfig,
+monetizationConfig
+FROM google.apigee.environments_addons_config
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_api_security_runtime_config/index.md b/docs/google-docs/providers/google/apigee/environments_api_security_runtime_config/index.md
index d58d23c6b9..0add3c7e07 100644
--- a/docs/google-docs/providers/google/apigee/environments_api_security_runtime_config/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_api_security_runtime_config/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_api_security_runtime_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_api_security_runtime_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_api_security_runtime_config
resource or lists environments_api_security_runtime_config
in a region
## Overview
@@ -30,12 +32,29 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the environment API Security Runtime configuration resource. Format: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` |
+| | `string` | Name of the environment API Security Runtime configuration resource. Format: `organizations/{org}/environments/{env}/apiSecurityRuntimeConfig` |
| | `array` | A list of up to 5 Cloud Storage Blobs that contain SecurityActions. |
| | `string` | Revision ID of the API Security Runtime configuration. The higher the value, the more recently the configuration was deployed. |
| | `string` | Unique ID for the API Security Runtime configuration. The ID will only change if the environment is deleted and recreated. |
| | `string` | Time that the API Security Runtime configuration was updated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config. |
+
+## `SELECT` examples
+
+Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.
+
+```sql
+SELECT
+name,
+location,
+revisionId,
+uid,
+updateTime
+FROM google.apigee.environments_api_security_runtime_config
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md
index 0333018931..93f4f1f143 100644
--- a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_debugmask
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_debugmask
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_debugmask
resource or lists environments_debugmask
in a region
## Overview
@@ -39,8 +41,50 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. |
| | `array` | List of XPaths that specify the XML elements to be filtered from XML response message payloads. |
| | `array` | List of variables that should be masked from the debug output. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the debug mask singleton resource for an environment. |
-| | `EXEC` | | Updates the debug mask singleton resource for an environment. |
+| | `UPDATE` | | Updates the debug mask singleton resource for an environment. |
+
+## `SELECT` examples
+
+Gets the debug mask singleton resource for an environment.
+
+```sql
+SELECT
+name,
+faultJSONPaths,
+faultXPaths,
+namespaces,
+requestJSONPaths,
+requestXPaths,
+responseJSONPaths,
+responseXPaths,
+variables
+FROM google.apigee.environments_debugmask
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `UPDATE` example
+
+Updates a environments_debugmask only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.environments_debugmask
+SET
+faultJSONPaths = '{{ faultJSONPaths }}',
+faultXPaths = '{{ faultXPaths }}',
+requestJSONPaths = '{{ requestJSONPaths }}',
+variables = '{{ variables }}',
+name = '{{ name }}',
+responseJSONPaths = '{{ responseJSONPaths }}',
+requestXPaths = '{{ requestXPaths }}',
+namespaces = '{{ namespaces }}',
+responseXPaths = '{{ responseXPaths }}'
+WHERE
+environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md b/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md
index 5a2bc7b931..f7ba2452cd 100644
--- a/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_deployed_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_deployed_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_deployed_config
resource or lists environments_deployed_config
in a region
## Overview
@@ -30,7 +32,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}` |
+| | `string` | Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}` |
| | `object` | RuntimeAddonsConfig defines the runtime configurations for add-ons in an environment. |
| | `string` | The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. |
| | `string` | Time that the environment configuration was created. |
@@ -53,7 +55,42 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `array` | List of target servers in the environment. Disabled target servers are not displayed. |
| | `object` | NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment. |
| | `string` | Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. |
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `SELECT` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `SELECT` | | Gets the deployed configuration for an environment. |
+
+## `SELECT` examples
+
+Gets the deployed configuration for an environment.
+
+```sql
+SELECT
+name,
+addonsConfig,
+arcConfigLocation,
+createTime,
+dataCollectors,
+debugMask,
+deploymentGroups,
+deployments,
+envScopedRevisionId,
+featureFlags,
+flowhooks,
+forwardProxyUri,
+gatewayConfigLocation,
+keystores,
+provider,
+pubsubTopic,
+resourceReferences,
+resources,
+revisionId,
+sequenceNumber,
+targets,
+traceConfig,
+uid
+FROM google.apigee.environments_deployed_config
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_environment/index.md b/docs/google-docs/providers/google/apigee/environments_environment/index.md
index 6fb80cfbd3..143b3edc39 100644
--- a/docs/google-docs/providers/google/apigee/environments_environment/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_environment/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_environment
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_environment
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_environment
resource or lists environments_environment
in a region
## Overview
@@ -28,8 +30,35 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
-`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command
+`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource.
+
+
## Methods
-| Name | Accessible by | Required Params |
-|:-----|:--------------|:----------------|
-| | `EXEC` | |
+| Name | Accessible by | Required Params | Description |
+|:-----|:--------------|:----------------|:------------|
+| | `UPDATE` | | Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. |
+
+## `UPDATE` example
+
+Updates a environments_environment only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.environments_environment
+SET
+deploymentType = '{{ deploymentType }}',
+forwardProxyUri = '{{ forwardProxyUri }}',
+description = '{{ description }}',
+state = '{{ state }}',
+nodeConfig = '{{ nodeConfig }}',
+properties = '{{ properties }}',
+name = '{{ name }}',
+createdAt = '{{ createdAt }}',
+hasAttachedFlowHooks = true|false,
+lastModifiedAt = '{{ lastModifiedAt }}',
+type = '{{ type }}',
+displayName = '{{ displayName }}',
+apiProxyType = '{{ apiProxyType }}'
+WHERE
+environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md b/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md
index a62caa368d..bc95015127 100644
--- a/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_iam_policies
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_iam_policies
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_iam_policy
resource or lists environments_iam_policies
in a region
## Overview
@@ -30,13 +32,27 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `object` | 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. |
-| | `array` | 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`. |
+| | `object` | 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. |
+| | `array` | 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`. |
| | `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). |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API. |
-| | `EXEC` | | Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API. |
| | `EXEC` | | Sets the IAM policy on an environment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.setIamPolicy` permission to call this API. |
| | `EXEC` | | Tests the permissions of a user on an environment, and returns a subset of permissions that the user has on the environment. If the environment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned). |
+
+## `SELECT` examples
+
+Gets the IAM policy on an environment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.environments.getIamPolicy` permission to call this API.
+
+```sql
+SELECT
+condition,
+members,
+role
+FROM google.apigee.environments_iam_policies
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md b/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md
index 19e371be64..adf8d947c9 100644
--- a/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_security_actions_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_security_actions_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_security_actions_config
resource or lists environments_security_actions_config
in a region
## Overview
@@ -30,11 +32,41 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
-| | `string` | This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config` |
+| | `string` | This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config` |
| | `boolean` | The flag that controls whether this feature is enabled. This is `unset` by default. When this flag is `false`, even if individual rules are enabled, no SecurityActions will be enforced. |
| | `string` | Output only. The update time for configuration. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | GetSecurityActionConfig returns the current SecurityActions configuration. |
-| | `EXEC` | | UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level. |
+| | `UPDATE` | | UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level. |
+
+## `SELECT` examples
+
+GetSecurityActionConfig returns the current SecurityActions configuration.
+
+```sql
+SELECT
+name,
+enabled,
+updateTime
+FROM google.apigee.environments_security_actions_config
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `UPDATE` example
+
+Updates a environments_security_actions_config only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.environments_security_actions_config
+SET
+updateTime = '{{ updateTime }}',
+name = '{{ name }}',
+enabled = true|false
+WHERE
+environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/environments_trace_config/index.md b/docs/google-docs/providers/google/apigee/environments_trace_config/index.md
index 8428349812..cbde277f3a 100644
--- a/docs/google-docs/providers/google/apigee/environments_trace_config/index.md
+++ b/docs/google-docs/providers/google/apigee/environments_trace_config/index.md
@@ -1,3 +1,4 @@
+
---
title: environments_trace_config
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- environments_trace_config
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an environments_trace_config
resource or lists environments_trace_config
in a region
## Overview
@@ -33,8 +35,38 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Required. Endpoint of the exporter. |
| | `string` | Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. |
| | `object` | TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Get distributed trace configuration in an environment. |
-| | `EXEC` | | Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body. |
+| | `UPDATE` | | Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body. |
+
+## `SELECT` examples
+
+Get distributed trace configuration in an environment.
+
+```sql
+SELECT
+endpoint,
+exporter,
+samplingConfig
+FROM google.apigee.environments_trace_config
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `UPDATE` example
+
+Updates a environments_trace_config only if the necessary resources are available.
+
+```sql
+UPDATE google.apigee.environments_trace_config
+SET
+exporter = '{{ exporter }}',
+samplingConfig = '{{ samplingConfig }}',
+endpoint = '{{ endpoint }}'
+WHERE
+environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/exports/index.md b/docs/google-docs/providers/google/apigee/exports/index.md
index 170200fef1..ffc13c8b14 100644
--- a/docs/google-docs/providers/google/apigee/exports/index.md
+++ b/docs/google-docs/providers/google/apigee/exports/index.md
@@ -1,3 +1,4 @@
+
---
title: exports
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- exports
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an export
resource or lists exports
in a region
## Overview
@@ -39,9 +41,90 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` |
| | `string` | Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. |
| | `string` | Output only. Time the export job was last updated. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Gets the details and status of an analytics export job. If the export job is still in progress, its `state` is set to "running". After the export job has completed successfully, its `state` is set to "completed". If the export job fails, its `state` is set to `failed`. |
| | `SELECT` | | Lists the details and status of all analytics export jobs belonging to the parent organization and environment. |
| | `INSERT` | | Submit a data export job to be processed in the background. If the request is successful, the API returns a 201 status, a URI that can be used to retrieve the status of the export job, and the `state` value of "enqueued". |
+
+## `SELECT` examples
+
+Lists the details and status of all analytics export jobs belonging to the parent organization and environment.
+
+```sql
+SELECT
+name,
+description,
+created,
+datastoreName,
+error,
+executionTime,
+self,
+state,
+updated
+FROM google.apigee.exports
+WHERE environmentsId = '{{ environmentsId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new exports
resource.
+
+
+
+
+```sql
+/*+ create */
+INSERT INTO google.apigee.exports (
+environmentsId,
+organizationsId,
+csvDelimiter,
+name,
+outputFormat,
+dateRange,
+datastoreName,
+description
+)
+SELECT
+'{{ environmentsId }}',
+'{{ organizationsId }}',
+'{{ csvDelimiter }}',
+'{{ name }}',
+'{{ outputFormat }}',
+'{{ dateRange }}',
+'{{ datastoreName }}',
+'{{ description }}'
+;
+```
+
+
+
+```yaml
+resources:
+ - name: instance
+ props:
+ - name: csvDelimiter
+ value: '{{ csvDelimiter }}'
+ - name: name
+ value: '{{ name }}'
+ - name: outputFormat
+ value: '{{ outputFormat }}'
+ - name: dateRange
+ value: '{{ dateRange }}'
+ - name: datastoreName
+ value: '{{ datastoreName }}'
+ - name: description
+ value: '{{ description }}'
+
+```
+
+
diff --git a/docs/google-docs/providers/google/apigee/flowhooks/index.md b/docs/google-docs/providers/google/apigee/flowhooks/index.md
index 4e1f6f0e13..3ce301bbd0 100644
--- a/docs/google-docs/providers/google/apigee/flowhooks/index.md
+++ b/docs/google-docs/providers/google/apigee/flowhooks/index.md
@@ -1,3 +1,4 @@
+
---
title: flowhooks
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- flowhooks
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an flowhook
resource or lists flowhooks
in a region
## Overview
@@ -34,9 +36,26 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `boolean` | Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception. Defaults to `true`. |
| | `string` | Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. |
| | `string` | Shared flow attached to this flow hook, or empty if there is none attached. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response. |
| | `EXEC` | | Attaches a shared flow to a flow hook. |
| | `EXEC` | | Detaches a shared flow from a flow hook. |
+
+## `SELECT` examples
+
+Returns the name of the shared flow attached to the specified flow hook. If there's no shared flow attached to the flow hook, the API does not return an error; it simply does not return a name in the response.
+
+```sql
+SELECT
+description,
+continueOnError,
+flowHookPoint,
+sharedFlow
+FROM google.apigee.flowhooks
+WHERE environmentsId = '{{ environmentsId }}'
+AND flowhooksId = '{{ flowhooksId }}'
+AND organizationsId = '{{ organizationsId }}';
+```
diff --git a/docs/google-docs/providers/google/apigee/host_queries/index.md b/docs/google-docs/providers/google/apigee/host_queries/index.md
index c64136916a..dab33c1449 100644
--- a/docs/google-docs/providers/google/apigee/host_queries/index.md
+++ b/docs/google-docs/providers/google/apigee/host_queries/index.md
@@ -1,3 +1,4 @@
+
---
title: host_queries
hide_title: false
@@ -5,7 +6,7 @@ hide_table_of_contents: false
keywords:
- host_queries
- apigee
- - google
+ - google
- stackql
- infrastructure-as-code
- configuration-as-data
@@ -16,9 +17,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
---
import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-
-
+Creates, updates, deletes or gets an host_query
resource or lists host_queries
in a region
## Overview
@@ -43,9 +45,111 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
| | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` |
| | `string` | Query state could be "enqueued", "running", "completed", "failed". |
| | `string` | Last updated timestamp for the query. |
+
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| | `SELECT` | | Get status of a query submitted at host level. If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed" |
| | `SELECT` | | Return a list of Asynchronous Queries at host level. |
| | `INSERT` | | Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of "enqueued" means that the request succeeded. |
+
+## `SELECT` examples
+
+Return a list of Asynchronous Queries at host level.
+
+```sql
+SELECT
+name,
+created,
+envgroupHostname,
+error,
+executionTime,
+queryParams,
+reportDefinitionId,
+result,
+resultFileSize,
+resultRows,
+self,
+state,
+updated
+FROM google.apigee.host_queries
+WHERE organizationsId = '{{ organizationsId }}';
+```
+
+## `INSERT` example
+
+Use the following StackQL query and manifest file to create a new host_queries
resource.
+
+
+